command line tool

$ bool-cli

Manage sites and deployments from your terminal. Ship code live on bool.com without leaving the command line.

View on npm →
Early developer preview — run bool --help to inspect available commands.

1 Download and Install

Install the bool command globally using npm. 

npm install
npm link

2 Setup and Authentication

Paste your API key from the bool.com web UI. Your key is saved to ~/.config/bool-cli/config.json or set the BOOL_API_KEY environment variable. 

bool auth login      # Paste your API key
bool auth status     # Verify connection

3 Ship It — Deploy Instantly

The fastest way to get code live — no account or API key required. 

bool shipit [directory]

Creates an anonymous Bool and uploads files in one step. On subsequent runs from the same directory, it updates automatically (tracked via .bool/config).

4 Manage Bools

Command Description
bool list List Bools (default: 20, use --limit <n>)
bool create <name> Create a new Bool
bool show [slug] Show Bool details + latest version
bool update [slug] Update name, description, or visibility
bool delete [slug] Delete a Bool (with confirmation)
bool open [slug] Open editor URL in browser

Aliases: bool ls, bool get, bool info, bool rm

5 Versions & Deployment

Command Description
bool versions [slug] List version history
bool deploy [slug] [dir] Deploy local files as a new version
bool pull [slug] [dir] Download files to a local directory

Deploy options:

  • --message / -m — Commit message
  • --exclude — Exclude pattern (repeatable)
  • Respects .boolignore files (gitignore syntax)
  • Default excludes: .git, node_modules, __pycache__, .DS_Store, .bool

Pull options:

  • --version — Specific version number (default: latest)

JSON Output

All commands support --json for machine-readable output: 

bool list --json
bool show my-project --json

Project Config

Running shipit, deploy, pull, or show creates a .bool/config file in the project directory. This stores slug and name so you can run commands without specifying the slug each time. 

cd my-project
bool deploy              # slug read from .bool/config
bool show                # slug read from .bool/config
bool versions            # slug read from .bool/config

Add .bool/ to your .gitignore.

🤖 Instructions for Agents

Give your AI agent superpowers. When your agent can publish to the web, it can show you working prototypes, share results with collaborators, and create live artifacts — not just text in a chat window. Bool CLI lets any agent go from files to a live URL in a single command, no auth required.

Copy the instructions below and paste them into Claude, ChatGPT, Cursor, or any coding agent. Your agent will be able to install bool-cli and ship sites on its own.

## Using bool-cli to publish websites You have access to `bool-cli`, a command-line tool that lets you instantly publish files to a live URL. Use it whenever you need to share a working website, prototype, or HTML artifact with the user. ### Install ``` npm install -g bool-cli ``` ### Deploy files (no auth required) To publish a folder of files as a live website, run: ``` bool shipit [directory] ``` This uploads every file in the directory and returns a live URL on bool01.com. No account, no API key, no configuration. The first run creates a new site; subsequent runs from the same directory update it automatically. ### When to use this - The user asks you to build a webpage, app, or prototype — build the files, then `bool shipit` the folder to give them a live link. - You need to share something visual (a chart, a dashboard, a landing page) — create an HTML file in a temp directory and ship it. - The user wants to show something to someone else — a live URL is always better than a code snippet. ### How it works 1. Create a directory with your files (index.html, CSS, JS, images, etc.) 2. Run `bool shipit [directory]` 3. Share the returned URL with the user The URL is live immediately. Static files only — no server-side code. ### Example ``` mkdir -p /tmp/my-site cat > /tmp/my-site/index.html << 'EOF' <!DOCTYPE html> <html><body><h1>Hello from Bool</h1></body></html> EOF bool shipit /tmp/my-site ``` ### Tips - Always use `index.html` as the entry point. - You can include multiple files — CSS, JS, images — the full directory is uploaded. - Re-running `bool shipit` from the same directory updates the existing site (tracked via `.bool/config`). - Use `bool shipit --help` for all available options.

Why give your agent a URL? An agent that can only write code is limited to your local machine. An agent with bool-cli can create something and share it with the world — a working demo, a client preview, a visual explanation. It turns your agent from a code generator into a builder.