### Get help for clisbot start Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/cli-commands.md Provides first-run help for tokens, bot bootstrap, and examples. ```bash clisbot start --help ``` -------------------------------- ### Install and Start clisbot Source: https://github.com/longbkit/clisbot/blob/main/README.md Install clisbot globally using npm and start it with essential configuration. Remove `--persist` to avoid saving the token. ```bash npm install -g clisbot clisbot start \ --cli codex \ --bot-type personal \ --telegram-bot-token \ --persist ``` -------------------------------- ### Get help for clisbot init Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/cli-commands.md Provides bootstrap help without starting the runtime. ```bash clisbot init --help ``` -------------------------------- ### Example: clisbot Start with Personal Bot Type and Token Source: https://github.com/longbkit/clisbot/blob/main/docs/tasks/features/configuration/2026-04-13-bot-type-first-run-flag-and-quick-start-refresh.md Demonstrates a complete `clisbot start` command for a personal bot, including the CLI, bot type, and Telegram token. ```bash clisbot start --cli codex --bot-type personal --telegram-bot-token ... ``` -------------------------------- ### Get Help for Clisbot Commands Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/README.md Displays help information for the 'start' and 'init' commands, providing details on their usage and options. ```bash clisbot start --help ``` ```bash clisbot init --help ``` -------------------------------- ### Start clisbot Bot Runtime Source: https://github.com/longbkit/clisbot/blob/main/README.md Use this command to start the bot runtime. It will also create the default first-run setup if needed. ```bash clisbot start ``` -------------------------------- ### Loop Started Reply Example Source: https://github.com/longbkit/clisbot/blob/main/docs/research/channels/2026-04-14-slash-command-output-audit.md A representative output when a loop is successfully started, detailing its ID, schedule, prompt, and cancellation command. ```text Started loop `loop123` every 2h. prompt: custom maxRuns: `...` policy: `skip-if-busy` activeLoops.session: `...` activeLoops.global: `...` cancel: `/loop cancel loop123` The first run starts now. ``` -------------------------------- ### Run Local Development Server Source: https://github.com/longbkit/clisbot/blob/main/README.md Installs dependencies and starts the bot locally using `bun`. This command is useful for development and testing, persisting data to a specified directory. ```bash bun install bun run start --cli codex --bot-type personal --telegram-bot-token --persist ``` -------------------------------- ### Start clisbot Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/cli-commands.md Use this command to bootstrap configuration if needed and start the detached runtime. ```bash clisbot start [first-run flags...] ``` -------------------------------- ### Example Startup Log for Timezone Detection Source: https://github.com/longbkit/clisbot/blob/main/docs/tasks/features/configuration/2026-04-26-timezone-config-cli-and-loop-resolution.md An example log output showing detected host timezone, configured app timezone, and instructions on how to change it. ```text Detected host timezone: Etc/UTC Configured app timezone: Etc/UTC Warning: host timezone is UTC. This may be a server timezone, not your real working timezone. To change it, ask the bot "set timezone to Vietnam time" or run: clisbot timezone set Asia/Ho_Chi_Minh ``` -------------------------------- ### `start` Capability Input Source: https://github.com/longbkit/clisbot/blob/main/docs/features/dx/cli-compatibility/capability-contract.md The input payload for the `start` capability, used to initiate a new runner instance. It can include session details and resume preferences. ```json { "capability": "start", "cli": "codex", "sessionKey": "telegram:default:-1003455688247:1207", "workspacePath": "/home/node/projects/clisbot", "agentId": "default", "resumePolicy": "fresh", "requestedSessionId": null, "reason": "new-turn" } ``` -------------------------------- ### Start Packaged Clisbot CLI (Background) Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/README.md Starts the clisbot CLI as a background service using npx. This is suitable for production environments where the service should run independently. ```bash npx clisbot start ``` -------------------------------- ### Upgrade clisbot to v0.1.39 Source: https://github.com/longbkit/clisbot/blob/main/docs/releases/v0.1.39.md Use these commands to upgrade your clisbot installation. Ensure you stop the current instance before installing the new version and start it again afterward. Verify the upgrade by checking the version. ```bash clisbot stop npm install -g clisbot clisbot start clisbot --version ``` -------------------------------- ### Binding Configuration Example Source: https://github.com/longbkit/clisbot/blob/main/docs/research/channels/2026-04-07-openclaw-agent-binding-account-channel-cli.md Illustrates the configuration structure for defining agents, channels with multiple accounts, and the bindings that map channel accounts to specific agents. ```json5 { agents: { defaults: { workspace: "~/.openclaw/workspace" }, list: [ { id: "work", workspace: "~/.openclaw/workspace-work" }, { id: "ops", workspace: "~/.openclaw/workspace-ops" } ] }, channels: { telegram: { defaultAccount: "default", accounts: { default: { name: "Primary bot", botToken: "123456:AAA..." }, ops: { name: "Ops bot", botToken: "123456:BBB..." } } } }, bindings: [ { match: { channel: "telegram", accountId: "default" }, agentId: "work" }, { match: { channel: "telegram", accountId: "ops" }, agentId: "ops" } ] } ``` -------------------------------- ### Start Clisbot with Specific CLI and Bot Type Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/README.md Starts the clisbot service with a specified CLI and bot type, useful for initial setup or specific bot configurations. The token is required for certain bot types like Telegram. ```bash bun run start --cli codex --bot-type personal --telegram-bot-token ``` -------------------------------- ### Get Application Timezone Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/cli-commands.md Retrieves the current application-wide timezone setting. Prefer this when the whole install should use one timezone. ```bash clisbot timezone get ``` -------------------------------- ### Install Queue-Workflow Skill Source: https://github.com/longbkit/clisbot/blob/main/docs/updates/releases/v0.1.50-release-guide.md Install the `queue-workflow` skill using `npx skills` and then explicitly state 'use queue workflow' followed by the task description to enable stronger queued follow-up execution. ```bash npx skills ``` -------------------------------- ### Optional Timezone Automation Flags for clisbot Start Source: https://github.com/longbkit/clisbot/blob/main/docs/tasks/features/configuration/2026-04-26-timezone-config-cli-and-loop-resolution.md Examples of using the --timezone flag during clisbot startup for explicit timezone configuration. ```bash clisbot start --cli codex --bot-type personal --timezone Asia/Ho_Chi_Minh --telegram-bot-token TELEGRAM_BOT_TOKEN --persist ``` ```bash clisbot init --cli codex --bot-type team --timezone Asia/Ho_Chi_Minh ``` -------------------------------- ### Bootstrap an Agent Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/README.md Initializes an agent with necessary guidance files. Requires specifying the agent ID and bot type. ```bash clisbot agents bootstrap --bot-type ``` -------------------------------- ### Example: clisbot Init with Team Bot Type Source: https://github.com/longbkit/clisbot/blob/main/docs/tasks/features/configuration/2026-04-13-bot-type-first-run-flag-and-quick-start-refresh.md Shows how to initialize a team bot using the `--bot-type` flag. ```bash clisbot init --cli claude --bot-type team ... ``` -------------------------------- ### Full Mode Example for Loop Tick Start Source: https://github.com/longbkit/clisbot/blob/main/docs/tasks/features/channels/2026-04-14-queued-and-loop-running-surface-notifications.md This 'full' mode notification provides maximum context for debugging or operational workflows, including the agent and prompt details. ```text Loop `loop123` started for agent `default` with prompt `daily review` in this thread. ``` -------------------------------- ### Start with Persistence Source: https://github.com/longbkit/clisbot/blob/main/docs/features/configuration/start-bootstrap-and-credential-persistence-operator-reference.md Bootstrap a personal bot and automatically persist its credentials to the canonical credential file before exiting. The configuration will be updated from `credentialType: "mem"` to `credentialType: "tokenFile"`. If persistence fails, startup will report the failure but still allow the runtime to use the in-memory credential. ```bash clisbot start \ --telegram-bot-token "$TELEGRAM_BOT_TOKEN" \ --bot-type personal \ --persist ``` -------------------------------- ### Example Migration Log Output Source: https://github.com/longbkit/clisbot/blob/main/docs/tasks/features/configuration/2026-04-26-timezone-config-cli-and-loop-resolution.md This log output demonstrates a successful configuration migration, including backing up the existing config, migrating timezone settings, and validating the upgraded schema. ```text config migration: backed up existing config to /home/user/.clisbot/config.backup.20260426T141500Z.json config migration: migrated app.control.loop.defaultTimezone=Asia/Ho_Chi_Minh to app.timezone config migration: removed legacy default-level bot timezone fields after moving timezone default to app.timezone config migration: validated upgraded config schemaVersion=0.1.50 config migration: applied upgraded config successfully config migration: existing persisted loops keep their stored timezone snapshots and will not shift ``` -------------------------------- ### Install clisbot v0.1.50 Source: https://github.com/longbkit/clisbot/blob/main/docs/releases/v0.1.50.md Install the latest stable version of clisbot globally using npm. After installation, restart the clisbot service to apply the updates. ```bash npm install -g clisbot@0.1.50 clisbot restart ``` -------------------------------- ### Loop Parse Error Example Source: https://github.com/longbkit/clisbot/blob/main/docs/research/channels/2026-04-14-slash-command-output-audit.md This example shows a typical parse error message for the `/loop` command, indicating missing parameters and providing examples of correct usage. ```text Loop requires an interval, count, or schedule. Try `/loop 5m check CI`, `/loop 3 check CI`, `/loop every day at 07:00 check CI`, or `/loop 3` for maintenance mode. ``` -------------------------------- ### Telegram Onboarding - Post-Configuration Commands Source: https://github.com/longbkit/clisbot/blob/main/docs/research/channels/2026-04-14-slash-command-output-audit.md Lists commands that will become functional after a Telegram group is configured. These are examples of routed commands available post-setup. ```text /status, /stop, /nudge, /followup, and /bash ``` -------------------------------- ### Suggested clisbot Configuration for Prompt Templates Source: https://github.com/longbkit/clisbot/blob/main/docs/features/channels/prompt-templates.md A comprehensive configuration example demonstrating how to set up prompt template behavior, sources, and overrides across the application, channels, and agents. ```json { "control": { "promptTemplates": { "templateDir": "~/.clisbot/templates/prompt-templates", "kinds": { "userMessage": { "enabled": true, "mode": "wrap-user", "template": "user-message" }, "steeringMessage": { "enabled": false, "mode": "prepend-system", "template": "steering-message" }, "loopMessage": { "enabled": true, "mode": "prepend-system", "template": "loop-message" } } } }, "channels": { "telegram": { "promptTemplates": { "kinds": { "steeringMessage": { "enabled": true } } } } }, "agents": { "defaults": { "promptTemplates": { "templateDir": "{workspace}/.clisbot/prompt-templates" } }, "list": [ { "id": "ops-agent", "promptTemplates": { "kinds": { "loopMessage": { "mode": "wrap-user" } } } } ] } } ``` -------------------------------- ### Telegram Addressing Examples Source: https://github.com/longbkit/clisbot/blob/main/docs/features/control/queues-cli.md Provides examples of how to address Telegram channels and targets using route-style notation for clarity and consistency. ```bash --channel telegram --target group:-1001234567890 --topic-id 4335 ``` ```bash --channel telegram --target topic:-1001234567890:4335 ``` -------------------------------- ### Manual Package Upgrade Source: https://github.com/longbkit/clisbot/blob/main/README.md Installs or updates the clisbot globally using npm and then restarts the service. Verify the installation by checking the version. ```bash npm install -g clisbot && clisbot restart clisbot --version ``` -------------------------------- ### Initialize clisbot Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/cli-commands.md Bootstraps configuration and an optional first agent without starting the runtime. ```bash clisbot init [first-run flags...] ``` -------------------------------- ### Start Clisbot Service (Foreground) Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/README.md Starts the clisbot service in the foreground. This is useful for development or when you want to monitor the service directly in your terminal. ```bash bun run start ``` -------------------------------- ### Update clisbot Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/cli-commands.md Prints the update guide, including stable/beta defaults plus migration, release-note, and release-guide links. ```bash clisbot update --help ``` -------------------------------- ### Default clisbot Start Command Source: https://github.com/longbkit/clisbot/blob/main/docs/tasks/features/configuration/2026-04-26-timezone-config-cli-and-loop-resolution.md The default command for starting clisbot without explicitly setting a timezone. It infers the host timezone. ```bash clisbot start --cli codex --bot-type personal --telegram-bot-token TELEGRAM_BOT_TOKEN --persist ``` -------------------------------- ### Fresh config with Slack only Source: https://github.com/longbkit/clisbot/blob/main/docs/features/configuration/start-bootstrap-and-credential-persistence.md Example of a fresh configuration file enabling only the Slack channel with a default account using in-memory credentials. ```json { "channels": { "slack": { "enabled": true, "defaultAccount": "default", "accounts": { "default": { "enabled": true, "credentialType": "mem" } } }, "telegram": { "enabled": false } } } ``` -------------------------------- ### Session Mapping API Examples Source: https://github.com/longbkit/clisbot/blob/main/docs/architecture/decisions/2026-05-01-session-key-and-session-id-continuity-decision.md These examples show the proposed public API for managing session mappings. Use these for interacting with session continuity state. ```javascript sessionMapping.get(sessionKey) ``` ```javascript sessionMapping.setActive(sessionRef, { sessionId, reason }) ``` ```javascript sessionMapping.clear(sessionRef, { reason, preserveRuntime? }) ``` -------------------------------- ### Successful CLI Startup Scenario Source: https://github.com/longbkit/clisbot/blob/main/docs/features/dx/cli-compatibility/real-cli-smoke-surface.md This JSON output represents a successful startup scenario for a CLI, indicating it is ready and has strong capabilities for starting, session management, and resuming. ```json { "cli": "codex", "scenario": "startup_ready", "ok": true, "grade": "strong", "capabilities": { "start": "strong", "probe": "partial", "sessionId": "strong", "resume": "strong", "interrupt": "partial" }, "finalState": "ready", "failureClass": null, "artifactDir": "~/.clisbot/artifacts/runner-smoke/2026-04-17T13-30-00Z-codex-startup_ready" } ``` -------------------------------- ### Example: clisbot Agents Bootstrap with Team Bot Type and Force Source: https://github.com/longbkit/clisbot/blob/main/docs/tasks/features/configuration/2026-04-13-bot-type-first-run-flag-and-quick-start-refresh.md Illustrates bootstrapping a team agent with the `--bot-type` flag and the `--force` option. ```bash clisbot agents bootstrap default --bot-type team --force ``` -------------------------------- ### Start Telegram Personal Bot Source: https://github.com/longbkit/clisbot/blob/main/docs/user-guide/cli-commands.md Initializes and starts a new Telegram personal bot. Requires a bot token and specifies the CLI and persistence settings. ```bash clisbot start \ --channel telegram \ --bot-token TELEGRAM_BOT_TOKEN \ --cli codex \ --bot-type personal \ --persist ```