@bisque/cli

Command-line interface for Bisque. Installs as the bisque binary.

The agent-facing reference (with flag tables and example payloads) lives at ../skills/shared/references/cli-reference.md. This README is a quick installation + command-list summary; treat the skill reference as authoritative.

Installation

# From repo root
pnpm install
pnpm build

cd packages/cli
npm link                    # exposes the `bisque` binary globally

Authentication

bisque auth login           # Opens browser, exchanges Clerk session for a persistent API key
bisque auth status          # Prints user, key prefix, endpoint
bisque auth logout

Credentials live in ~/.bisque/config.json. The login flow uses a short-lived auth code (POST /v1/auth/codes → POST /v1/auth/exchange); the API key never appears in a URL.

To point at a non-default endpoint:

bisque config set apiEndpoint http://localhost:3000   # local backend
# Production endpoint is baked in; no flag needed for hosted use.

Command Index

Documents

• bisque add <file> — upload (default 0-Inbox/); flags: --project|--area|--resource <name>, --tags, --filepath, --content, --title, --metadata <json>
• bisque bulk-add <pattern> — upload multiple files
• bisque get <id> [-o file.md] — fetch document by UUID
• bisque update <id> — flags: --title, --content, --tags, --keywords, --metadata
• bisque delete <id>
• bisque list — list documents (supports --path-prefix, --filepath, --workspace)
• bisque ls [path] / bisque tree [path] — filesystem-style views
• bisque search <query> — keyword search; flags include --category, --tags
• bisque move <id> <new-path>
• bisque link <id> <linked-ids...>
• bisque tag <id> <tags...>

Tasks + chains

• bisque task create|list|get|update|claim|delete
  • task update supports --chain-order <num> (fractional values allowed)
• bisque chain create|list|get|update
• bisque batch <ops.json> — apply a batch of CRUD operations

Agent personas

• bisque persona list|get|create|update|delete
• bisque persona add-learning <id> <text>
• bisque persona add-feedback <id> <text>
• bisque agents refresh <path> — regenerate AGENTS.md for a workspace directory

Workspace + maintenance

• bisque workspace list|get|default
• bisque inbox list
• bisque manifest — workspace summary
• bisque recall "<topic>" — context-based retrieval
• bisque maintenance — workspace health analysis + mechanical fixes
• bisque load "<project>" — load AGENTS.md + frontmind for a project
• bisque plugin install [--force] — register the Claude Code plugin
• bisque config show|get|set <key> [value]

Output formats

Most read commands accept --json for scripting:

bisque list --json | jq '.[] | select(.tags | contains(["urgent"]))'
bisque workspace list --json

Exit codes

| Code | Meaning | |---|---| | 0 | Success | | 1 | General error (network, validation) | | 2 | Authentication error (re-run bisque auth login) | | 3 | Resource not found |

Configuration file

~/.bisque/config.json:

{
  "apiEndpoint": "https://api.bisquelayer.com",
  "apiKey": "bsk_..."
}

apiEndpoint is normalized to a bare origin (no trailing /v1, no trailing slash) — route paths handle their own /v1/... prefix.

Development

pnpm dev      # tsx watch
pnpm build    # tsc
pnpm test     # vitest
pnpm lint     # biome