Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/shobcoder/shob/llms.txt

Use this file to discover all available pages before exploring further.

The Shob CLI is distributed as the shob-code npm package. Installing it globally adds the shob binary to your PATH, giving you access to all commands — from running AI coding sessions to managing providers, plugins, and MCP servers — directly from your terminal on macOS, Linux, or Windows.

​
System Requirements

RequirementMinimum version
Node.js18 or later
npm / bun / pnpm / yarnAny current release
Operating SystemmacOS, Linux, or Windows
Bun is the recommended runtime for the fastest cold-start and best compatibility with Shob internals. The CLI runs correctly on any Node.js-compatible runtime.

​
Installation

Install shob-code globally with your preferred package manager: 
npm install -g shob-code

​
Verify the Installation

Confirm that the shob binary is available and shows the correct version: 
shob --version
Expected output: 
0.0.2
You can also display the full help text to confirm all commands are registered: 
shob --help

​
Upgrading

To upgrade Shob to the latest release, reinstall the package globally with the same package manager you used during installation: 
npm update -g shob-code
Alternatively, use Shob’s built-in upgrade command, which auto-detects your package manager: 
shob upgrade
To upgrade to a specific version: 
shob upgrade 0.0.2
If shob upgrade cannot detect your package manager it will prompt you to select one manually. You can also pass --method with one of the supported values — npm, pnpm, bun, brew, curl, choco, or scoop — to skip the prompt.

​
Desktop App

A graphical desktop application for Shob is also available, providing a visual interface for managing sessions, reviewing diffs, and monitoring agent activity without leaving your workflow.

Shob Desktop App

Learn how to install and use the Shob desktop application.

​
Global Flags

The following flags can be passed to any shob command and take effect before the command handler runs:
FlagTypeDescription
--log-levelDEBUG | INFO | WARN | ERRORSet the minimum log level written to the log file. Defaults to INFO on released builds and DEBUG on local builds.
--print-logsbooleanPrint log output to stderr in addition to the log file. Useful for debugging or piping logs to external tooling.
--purebooleanRun without loading any external plugins. Useful for reproducing issues in a clean environment or running in restricted CI contexts.

​
Examples

# Show debug logs in the terminal while running a task
shob run --print-logs --log-level DEBUG "Refactor the database layer"

# Run with all plugins disabled
shob run --pure "Generate a summary of recent commits"
Log files are written to a persistent path in your Shob data directory. If something goes wrong, Shob will print the exact log file path in the error output so you can inspect it directly.

Build docs developers (and LLMs) love

Get started for freeTalk to us