{"_id":"@codebolt/client-cli","_rev":"3-40db7e45ffba69e72428dce60e6c60aa","name":"@codebolt/client-cli","dist-tags":{"latest":"0.1.4"},"versions":{"0.1.2":{"name":"@codebolt/client-cli","version":"0.1.2","_id":"@codebolt/client-cli@0.1.2","maintainers":[{"name":"ravirawatsingh","email":"ravi@arrowai.com"},{"name":"utkarshx","email":"utk.shukla@gmail.com"}],"bin":{"codebolt-client":"bin/codebolt-client"},"dist":{"shasum":"fb24c8fae86128dede790f534cdb6125fac76a5e","tarball":"https://registry.npmjs.org/@codebolt/client-cli/-/client-cli-0.1.2.tgz","fileCount":24,"integrity":"sha512-Q/LoK3w9BYvbsk3CGC8iBZqG3l27Cc8cihbRIobzbqWYtiUJf4SOrbfU+GdZFK5dGdCxzPWRCDFjZ3N8FIEn2A==","signatures":[{"sig":"MEYCIQDMsoQ+tf2ybQliAuzW0M93IqzgDBcXFWLwhFPQAvveIwIhAIimx2iCNBZe85UF1gWPKd96pcqLe4xC7QKYANqvNo0v","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1990249},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"8a9f9b529adaedb1a67f77759a8ec229bd2ab016","scripts":{"dev":"tsc --watch","build":"npm run build:deps && webpack --config webpack.config.js","clean":"rm -rf dist","build:tsc":"tsc","typecheck":"tsc --noEmit","build:deps":"npm --prefix ../../CodeBolt/packages/types run build --if-present && npm --prefix ../../CodeBolt/sdks/clientsdk run build","build:local":"webpack --config webpack.config.js","prepublishOnly":"npm run build"},"_npmUser":{"name":"utkarshx","email":"utk.shukla@gmail.com"},"_npmVersion":"11.11.0","description":"CLI client for CodeBolt server using the client SDK","directories":{},"_nodeVersion":"20.18.3","dependencies":{},"_hasShrinkwrap":false,"devDependencies":{"ws":"^8.17.0","webpack":"^5.0.0","@types/ws":"^8.5.12","commander":"^12.0.0","ts-loader":"^9.0.0","typescript":"^5.4.5","@types/node":"^20.17.27","webpack-cli":"^5.0.0","@codebolt/types":"file:../../CodeBolt/packages/types","@codebolt/client-sdk":"file:../../CodeBolt/sdks/clientsdk"},"_npmOperationalInternal":{"tmp":"tmp/client-cli_0.1.2_1778078823509_0.7810278831617552","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@codebolt/client-cli","version":"0.1.3","_id":"@codebolt/client-cli@0.1.3","maintainers":[{"name":"ravirawatsingh","email":"ravi@arrowai.com"},{"name":"utkarshx","email":"utk.shukla@gmail.com"}],"bin":{"codebolt-client":"bin/codebolt-client"},"dist":{"shasum":"a42a14e5a2e6ad13535fc97d445b6961ea28de71","tarball":"https://registry.npmjs.org/@codebolt/client-cli/-/client-cli-0.1.3.tgz","fileCount":25,"integrity":"sha512-ig7Um4Tp2odkV4TN13SaDec8BzYYxly1hi3kF7qrYCMpc0Rm4mc/Z6WZVorILiX7v2KYY7VodqTnKGI9bjUCbA==","signatures":[{"sig":"MEQCIBidlNQ8AinzCx917QrsYLthTgureu8B6nwKpKIPBILuAiAT4unuVv0gb+oYybMclMDQlydT7eojVsCydMXFkZpGgg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1996804},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"8a9f9b529adaedb1a67f77759a8ec229bd2ab016","scripts":{"dev":"tsc --watch","build":"npm run build:deps && webpack --config webpack.config.js","clean":"rm -rf dist","build:tsc":"tsc","typecheck":"tsc --noEmit","build:deps":"npm --prefix ../../CodeBolt/packages/types run build --if-present && npm --prefix ../../CodeBolt/sdks/clientsdk run build","build:local":"webpack --config webpack.config.js","prepublishOnly":"npm run build"},"_npmUser":{"name":"utkarshx","email":"utk.shukla@gmail.com"},"_npmVersion":"11.11.0","description":"CLI client for CodeBolt server using the client SDK","directories":{},"_nodeVersion":"20.18.3","dependencies":{},"_hasShrinkwrap":false,"devDependencies":{"ws":"^8.17.0","webpack":"^5.0.0","@types/ws":"^8.5.12","commander":"^12.0.0","ts-loader":"^9.0.0","typescript":"^5.4.5","@types/node":"^20.17.27","webpack-cli":"^5.0.0","@codebolt/types":"file:../../CodeBolt/packages/types","@codebolt/client-sdk":"file:../../CodeBolt/sdks/clientsdk"},"_npmOperationalInternal":{"tmp":"tmp/client-cli_0.1.3_1778079378620_0.4079811388724548","host":"s3://npm-registry-packages-npm-production"}},"0.1.4":{"name":"@codebolt/client-cli","version":"0.1.4","description":"CLI client for CodeBolt server using the client SDK","main":"dist/index.js","bin":{"codebolt-client":"bin/codebolt-client"},"scripts":{"build":"npm run build:deps && webpack --config webpack.config.js","build:deps":"npm --prefix ../../CodeBolt/packages/types run build --if-present && npm --prefix ../../CodeBolt/sdks/clientsdk run build","build:local":"webpack --config webpack.config.js","build:tsc":"tsc","dev":"tsc --watch","clean":"rm -rf dist","typecheck":"tsc --noEmit","prepublishOnly":"npm run build"},"dependencies":{},"devDependencies":{"@codebolt/client-sdk":"file:../../CodeBolt/sdks/clientsdk","@codebolt/types":"file:../../CodeBolt/packages/types","commander":"^12.0.0","typescript":"^5.4.5","@types/node":"^20.17.27","@types/ws":"^8.5.12","ts-loader":"^9.0.0","webpack":"^5.0.0","webpack-cli":"^5.0.0","ws":"^8.17.0"},"gitHead":"8a9f9b529adaedb1a67f77759a8ec229bd2ab016","types":"./dist/index.d.ts","_id":"@codebolt/client-cli@0.1.4","_nodeVersion":"20.18.3","_npmVersion":"11.11.0","dist":{"integrity":"sha512-XCwY3otsHXvRxI2NLmpRuCWFcIS+UmalQd9Ydc+rtchIAL4vjedR98gq/1qA8qW7wh3VmJMYc91wQukApgI/kg==","shasum":"d61234a46b9edcf57dad06e166d906dc12ddafaa","tarball":"https://registry.npmjs.org/@codebolt/client-cli/-/client-cli-0.1.4.tgz","fileCount":25,"unpackedSize":1996884,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIGwLkNjXFkWrkmbJxoih4nAAMTRVo/ZUf/mnU4kI1Il3AiBNC2iIaiapk6QFvH18hUS++E7pB1URCxmKV7bTSlNn/A=="}]},"_npmUser":{"name":"utkarshx","email":"utk.shukla@gmail.com"},"directories":{},"maintainers":[{"name":"ravirawatsingh","email":"ravi@arrowai.com"},{"name":"utkarshx","email":"utk.shukla@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/client-cli_0.1.4_1778079589750_0.49457829277417664"},"_hasShrinkwrap":false}},"time":{"created":"2026-05-06T14:47:03.406Z","modified":"2026-05-06T14:59:50.113Z","0.1.2":"2026-05-06T14:47:03.785Z","0.1.3":"2026-05-06T14:56:18.802Z","0.1.4":"2026-05-06T14:59:49.986Z"},"description":"CLI client for CodeBolt server using the client SDK","maintainers":[{"name":"ravirawatsingh","email":"ravi@arrowai.com"},{"name":"utkarshx","email":"utk.shukla@gmail.com"}],"readme":"# @codebolt/client-cli\n\nCommand-line client for interacting with a running CodeBolt server from scripts, terminals, CI jobs, and local development workflows.\n\nThe CLI wraps the CodeBolt client SDK and exposes high-level commands for chat, agents, projects, tasks, memory, knowledge, browser automation, MCP servers, and other CodeBolt server resources.\n\n## Installation\n\nInstall globally:\n\n```sh\nnpm install -g @codebolt/client-cli\n```\n\nRun without a global install:\n\n```sh\nnpx @codebolt/client-cli --help\n```\n\nAfter installation, the executable is:\n\n```sh\ncodebolt-client --help\n```\n\n## Requirements\n\n- Node.js 20 or newer is recommended.\n- A running CodeBolt server that exposes the client HTTP and WebSocket APIs.\n- Network access from your terminal to the server host and port.\n\nBy default, the CLI connects to:\n\n```text\nlocalhost:12345\n```\n\nYou can override this with `--host`, `--port`, or the `SOCKET_PORT` environment variable.\n\n## Global Options\n\nThese options are available on the root command and apply to subcommands:\n\n```text\n-p, --port <number>   Server port. Defaults to SOCKET_PORT or 12345.\n-H, --host <string>   Server hostname. Defaults to localhost.\n--json                Emit machine-readable JSON where supported.\n--debug               Enable debug logging.\n--timeout <ms>        HTTP timeout in milliseconds. Defaults to 30000.\n```\n\nExample:\n\n```sh\ncodebolt-client --host 127.0.0.1 --port 12345 --json project info\n```\n\n## Quick Start\n\nCheck the CLI:\n\n```sh\ncodebolt-client system check-cli\n```\n\nSend a chat message and wait for completion:\n\n```sh\ncodebolt-client chat send --message \"Summarize the current project\"\n```\n\nSend a chat message with streamed output:\n\n```sh\ncodebolt-client chat send-streaming --message \"Create a task plan for this bug\"\n```\n\nList installed agents:\n\n```sh\ncodebolt-client agent list\n```\n\nGet current project information:\n\n```sh\ncodebolt-client project info\n```\n\n## Command Groups\n\nUse `codebolt-client help <command>` for command-specific options.\n\n| Command | Purpose |\n| --- | --- |\n| `chat` | Send messages, stream responses, manage threads, and store chat messages. |\n| `agent` | List, install, start, stop, update, and inspect agents. |\n| `execution` | Inspect agent executions and execution trees. |\n| `git` | Run CodeBolt-backed git operations such as status, diff, commit, branch, push, pull, and clone. |\n| `task` | Create, update, list, delete, and inspect tasks. |\n| `project` | Read and update project context, active project, threads, and chat history. |\n| `workspace` | List, inspect, and select workspaces. |\n| `llm` | List providers and models, update keys, set defaults, and inspect local model state. |\n| `memory` | Manage generic, markdown, JSON, context, and episodic memory. |\n| `knowledge` | Manage knowledge collections, documents, URLs, and strategies. |\n| `swarm` | Create, start, stop, inspect, and manage swarms, teams, roles, and swarm agents. |\n| `env` | Manage environments and environment providers. |\n| `job` | Create, update, list, delete, and inspect jobs. |\n| `actionblock` | List action blocks, inspect details, stop executions, and view stats. |\n| `browser` | Navigate, click, fill, screenshot, and send browser automation actions. |\n| `mcp` | List, inspect, configure, toggle, and install MCP servers. |\n| `file` | Check for files and add file content through the CodeBolt server. |\n| `system` | Check or install CLI-related system state. |\n\n## Common Examples\n\nList chat threads:\n\n```sh\ncodebolt-client chat threads list\n```\n\nCreate a task:\n\n```sh\ncodebolt-client task create --title \"Investigate failing build\" --priority high\n```\n\nUpdate a task:\n\n```sh\ncodebolt-client task update task_123 --status in-progress\n```\n\nShow git status:\n\n```sh\ncodebolt-client git status\n```\n\nCreate a git commit:\n\n```sh\ncodebolt-client git commit --message \"Fix client CLI package metadata\"\n```\n\nNavigate the browser:\n\n```sh\ncodebolt-client browser navigate --url \"http://localhost:3000\"\n```\n\nConfigure an MCP server from JSON:\n\n```sh\ncodebolt-client mcp configure --data \"{\\\"name\\\":\\\"local-server\\\",\\\"enabled\\\":true}\"\n```\n\n## JSON Output\n\nUse `--json` for automation and scripts:\n\n```sh\ncodebolt-client --json task list --status open\n```\n\nFor commands that return structured data, the CLI writes JSON to stdout. Errors are written in a consistent error format where supported.\n\n## Chat Completion Output\n\n`chat send` and `chat send-streaming` connect to the CodeBolt chat WebSocket endpoint and wait for the agent process to finish.\n\nWhen the server provides debug information, completion output can include:\n\n- Thread ID\n- Project path\n- Thread chat path\n- Debug log paths\n- Child agent execution details\n\nUse `--timeout` on chat commands for long-running agent work:\n\n```sh\ncodebolt-client chat send --message \"Run the full review\" --timeout 900000\n```\n\n## Local Development\n\nThis package is built from the `codeboltjs` checkout and uses local sibling packages from the main `CodeBolt` checkout:\n\n- `../../CodeBolt/packages/types`\n- `../../CodeBolt/sdks/clientsdk`\n\nInstall dependencies:\n\n```sh\nnpm install\n```\n\nBuild the CLI and its local SDK/type dependencies:\n\n```sh\nnpm run build\n```\n\nBuild only the CLI bundle:\n\n```sh\nnpm run build:local\n```\n\nType-check without emitting files:\n\n```sh\nnpm run typecheck\n```\n\nCreate a local npm tarball preview:\n\n```sh\nnpm pack --json --ignore-scripts\n```\n\n## Publishing\n\nThe package publishes the bundled `dist` output and the executable in `bin`.\n\nBefore publishing:\n\n```sh\nnpm install\nnpm run build\nnpm pack --json --ignore-scripts\n```\n\nPublish publicly:\n\n```sh\nnpm publish --access public\n```\n\n## Troubleshooting\n\n### npm install returns 404\n\nIf the npm website shows the package but `npm install` returns 404, check that npm is using the public registry:\n\n```sh\nnpm config get registry\nnpm config get @codebolt:registry\n```\n\nForce the public registry for one install:\n\n```sh\nnpm install -g @codebolt/client-cli --registry=https://registry.npmjs.org/\n```\n\nIf the package was just published, npm registry propagation can briefly lag behind the website. Retry after a few minutes.\n\n### Cannot connect to the server\n\nVerify the CodeBolt server is running and that the CLI is using the correct host and port:\n\n```sh\ncodebolt-client --host localhost --port 12345 system check-cli\n```\n\n### Commands need JSON payloads\n\nMany commands accept JSON through `--data`. Quote JSON according to your shell. In PowerShell:\n\n```powershell\ncodebolt-client job create --data '{\\\"title\\\":\\\"Build package\\\",\\\"status\\\":\\\"open\\\"}'\n```\n\n## License\n\nMIT\n","readmeFilename":"README.md"}