代码智能助手

Installation

deploy-staging

Run the test suite, build, then npm run deploy:staging. If the build fails, surface the error and stop — don't deploy a broken build. ```

A long description can also be a folded (>) or literal (|) block. Files a skill refers to, such as a reporting.md guide, sit next to its SKILL.md: invoke_skill tells the agent the skill's directory and reads them from there.

The agent gets the bundle catalog injected into its system prompt on every iteration and can invoke any bundle via the invoke_skill tool:

• /skills bundles — list installed bundles
• /skills create-bundle <name> — scaffold a new project skill
• /skills show <name> — print the SKILL.md
• /skills browse [query] — search the public marketplace
• /skills install <owner>/<slug> — pull from marketplace
• /skills publish <name> [--public] — share to codeep.dev
• /skills unpublish <owner>/<slug> — remove your published skill

Web marketplace: publish skills to codeep.dev/skills as public (browseable by anyone) or private (only you). Manage your published skills at /dashboard/skills. From the VS Code extension, use the Codeep: Browse Skill Bundles… / Codeep: Create Skill Bundle… / Codeep: Open Skills Folder commands.

Example for macOS Apple Silicon:

curl -fsSL https://github.com/VladoIvankovic/Codeep/releases/latest/download/codeep-macos-arm64 -o codeep chmod +x codeep sudo mv codeep /usr/local/bin/ ```

Quick Start

```bash

Option 1: npm (Recommended)

npm install -g codeep

Update:

npm update -g codeep

Option 2: curl

For a machine without Node. The script is served from codeep.dev and fetched from this repository's newest release, so the command does not change if the repository moves.

curl -fsSL https://codeep.dev/install.sh | bash

Custom installation directory:

curl -fsSL https://codeep.dev/install.sh | INSTALL_DIR=~/.local/bin bash

Specific version:

curl -fsSL https://codeep.dev/install.sh | VERSION=3.1.1 bash

Option 3: Manual Binary

Download the latest binary for your platform from GitHub Releases:

```bash

maxIterations: 12 # optional budget

You write safe, reversible DB migrations… ```

tools is an allowlist enforced at dispatch (a researcher literally can't write files). Sub-agents inherit your profile + project rules, and their changes are covered by /undo.

Guaranteed review: enable Agent Auto-Review in /settings (agentAutoReview) and after any run that changes files, Codeep automatically delegates to the reviewer and appends its findings — a review stage that always happens; a reviewer that writes nothing is shown as "(the reviewer finished without writing a review)". Off by default.

Optional Codeep-specific extensions:

codeep-min-version: 2.0.0 codeep-requires-mcp: [postgres] allowed-tools: [read_file, write_file, execute_command]

Self-Verification (Optional)

When enabled in Settings, the agent can automatically verify its changes by running build, tests, or type checking after completing a task. Disabled by default — the agent works freely and you decide when to verify.

Configure in Settings → Agent Auto-Verify: - Off (default) — no automatic verification - Build only — checks compilation after changes - Typecheck only — runs TypeScript/PHP type checking - Test only — runs test suite after changes - Build + Typecheck + Test — full verification

If errors are found, the agent tries to fix them automatically (up to 3 attempts, configurable).

Supported project types:

Personal config sync

account sync / account push also carry your personalities and custom slash commands between machines — the Markdown files in ~/.codeep/personalities/ and ~/.codeep/commands/:

codeep account push   # Upload local personalities + commands to codeep.dev
codeep account sync   # Download them onto a new machine

A manual sync treats the dashboard personality as current. When a changed cloud personality replaces a local file, Codeep first saves the local version under ~/.codeep/backups/personalities/ and then swaps the new file in atomically. Custom commands keep the older additive merge and are never overwritten by a pull. View and edit custom bots in Agent Studio, and prune commands under Custom commands, on the dashboard.

Hooks and MCP server configs are deliberately not synced: hooks run arbitrary shell, and MCP configs often embed tokens, so both stay local to each machine.

AI Configuration

Model favorites — save provider+model combos and switch instantly:

> /provider      # switch to z.ai
> /model glm-5.2
> /profile save fast

> /provider      # switch to openai
> /model gpt-5.6-sol
> /profile save work

> /model fast    # instantly switch to z.ai / glm-5.2
> /model work    # instantly switch to openai / gpt-5.6-sol

On first run, enter your API key

API key sync

API keys are opt-in: they stay in your OS keychain until you turn on cloud key sync, with /keysync on or from the shell. Synced keys are stored server-readable on codeep.dev — encrypted at rest using AES-256-GCM, with a key the server holds. Add keys once on the dashboard, then sync them to any machine:

codeep account sync --keys  # Turn on key sync and pull your keys — a new machine's first step
codeep account sync         # Pull keys (when key sync is on) + config from codeep.dev → local
codeep account push         # Push this machine's stored keys (when key sync is on) + config → codeep.dev

--keys shows the same note as /keysync on before turning it on, and key sync stays on afterwards. On a terminal, on a machine with no API key yet, `codeep account sync without --keys` asks first (No by default); a machine that already has a key, a script, a pipe and CI are never asked, only told the command to run. Keys pressed before a question appears never answer it, and Ctrl+C at a question cancels the sync with nothing pulled. After a pull on a terminal, or with --keys, if the provider Codeep would start on has no key (one in the environment counts), it switches to the first of the pulled keys' providers in the order /provider lists them, so the next codeep opens the chat rather than the provider picker. Without a system keychain the keys are stored in plain text in the config file, and the sync says so. codeep account offers this sync as soon as it has linked the machine.

With key sync on, codeep account push uploads the API keys stored on this machine — in the system keychain, or the plain-text fallback — and never a key read from an environment variable; it names the providers it left out for that reason. /keysync off turns key sync off again, codeep account purge-keys deletes the keys stored on codeep.dev, and CODEEP_NO_KEY_SYNC=1 keeps it off whatever the setting says.

Git Integration

• /diff - Review unstaged changes with AI assistance
• /diff --staged - Review staged changes
• /commit - Generate conventional commit messages

Git Integration