Installation

Install kimbap with the release script, Homebrew, or from source, then initialize a workspace and link the credentials your services need.

Prerequisites

• Go 1.24+ — required only for source builds
• macOS or Linux
• Docker — optional, only needed if you want to run kimbap with Postgres instead of the default SQLite

Install kimbap

Choose the install path that best fits your environment.

Quick install (binary)

curl -fsSL https://kimbap.sh/install.sh | bash

Downloads the latest release binary, verifies SHA256 checksum, and installs kimbap (with kb created as a local alias symlink). Install path: /usr/local/bin if writable, or via sudo in interactive shells, falling back to ~/.local/bin with PATH instructions. May prompt to run quickstart init in interactive shells.

Pin a specific version:

curl -fsSL https://kimbap.sh/install.sh | bash -s -- --version 0.1.0

Check current installed version against latest release:

curl -fsSL https://kimbap.sh/install.sh | bash -s -- --check

Install and immediately configure skills for detected supported agents in the current project (override with --agent-kinds if needed):

curl -fsSL https://kimbap.sh/install.sh | bash -s -- --with-agents

--agent-kinds for installer setup supports: claude-code,opencode,codex,cursor,openclaw,nanoclaw.
(generic is sync-only via kimbap agents sync --agent generic --dir <project>.)

If no kimbap config/services exist yet, installer offers interactive service selection first (default quickstart mode: select, with recommended services preselected).
Use --quickstart-services all when you want the full catalog on first setup.

Control quickstart service selection during install:

# default is interactive select
curl -fsSL https://kimbap.sh/install.sh | bash -s -- --quickstart-services select

# install recommended curated defaults directly
curl -fsSL https://kimbap.sh/install.sh | bash -s -- --quickstart-services recommended

# install all catalog services
curl -fsSL https://kimbap.sh/install.sh | bash -s -- --quickstart-services all

# skip service install during quickstart init
curl -fsSL https://kimbap.sh/install.sh | bash -s -- --quickstart-services none

Homebrew (macOS / Linux)

brew install dunialabs/kimbap/kimbap

Upgrade later:

brew update && brew upgrade dunialabs/kimbap/kimbap

For script installs, manual update is rerunning the installer:

curl -fsSL https://kimbap.sh/install.sh | bash

Uninstall

If you installed using install.sh, remove script-managed binaries (kimbap, kb):

curl -fsSL https://kimbap.sh/install.sh | bash -s -- --uninstall

Also remove resolved local kimbap data/config paths (default ~/.kimbap; respects KIMBAP_DATA_DIR / KIMBAP_CONFIG when set):

curl -fsSL https://kimbap.sh/install.sh | bash -s -- --uninstall --purge-data

If you installed with Homebrew, uninstall with:

brew uninstall dunialabs/kimbap/kimbap

From source

Requires Go 1.24+. See `scripts/install-from-source.sh` for the full script, or:

git clone https://github.com/dunialabs/kimbap.git
cd kimbap
make deps && make build
# binary at ./bin/kimbap

Initialize workspace

Local / dev evaluation

kimbap init --services select

Dev mode auto-generates a vault master key and stores it in ~/.kimbap/.dev-master-key. In interactive mode, --services select opens a checklist with recommended services preselected (you can switch to all from the checklist).
If services are installed during init, eligible shortcut aliases are set up by default. Use --no-shortcuts to skip.

After init, you can run shortcuts directly (no kimbap call prefix):

geosearch --name "San Francisco"
weather --latitude 37.7749 --longitude -122.4194

Production

export KIMBAP_MASTER_KEY_HEX="$(openssl rand -hex 32)"
kimbap init --mode embedded --services all

Store the key securely. You need it every time the vault is unlocked. Use --services all explicitly in scripts and other non-interactive environments.

What init does

• Creates ~/.kimbap/ as the data directory
• Generates config.yaml with default settings
• Initializes the encrypted vault
• Creates a default policy file
• Installs selected catalog service manifests (all/recommended/custom via --services)

Init flags:

Store credentials

Secrets are never accepted as inline CLI arguments. The easiest way to store and link a credential in one step:

# From environment variable (stores + links in one step)
printf '%s' "$GITHUB_TOKEN" | kimbap link github --stdin

# From file
kimbap link stripe --file ./key.txt

Or use kimbap vault set for direct vault access:

printf '%s' "$GITHUB_TOKEN" | kimbap vault set github.token --stdin
kimbap vault set stripe.api_key --file ./key.txt

The vault is encrypted with a master key. In dev mode (--mode dev or KIMBAP_DEV=true), the key is auto-generated and stored locally. In production, set KIMBAP_MASTER_KEY_HEX explicitly.

Link services to credentials

For interactive setup, kimbap link guides you through credential or OAuth configuration:

kimbap link github
kimbap link stripe

Linking tells kimbap which credential to inject when that service's actions are called.

OAuth setup

For services backed by OAuth rather than static API keys:

kimbap auth connect slack
kimbap auth connect notion
kimbap auth connect zoom

Bundled OAuth providers: canva, canvas, figma, notion, slack, stripe, zendesk, zoom.

Each command starts the OAuth flow for that provider and stores the resulting tokens in the connector auth store (encrypted separately from the vault).

Configure your AI agent

kimbap ships with profiles for common AI coding agents. Use --with-profiles to write project-level operating rules files so the agent discovers kimbap when working in that project.

# Auto-detect and install global discovery hints for installed agents
kimbap agents setup

# Also sync service discovery into current project
kimbap agents setup --sync --dir "$PWD"

# Also install agent operating profiles into the project directory
kimbap agents setup --sync --with-profiles --dir "$PWD"

# Sync service discovery (generates SKILL.md per service)
kimbap agents sync

# Force project SKILL sync for OpenCode in current project
kimbap agents sync --agent opencode --dir "$PWD" --force

# OpenClaw official workspace sync
kimbap agents sync --agent openclaw --dir "$HOME/.openclaw/workspace"

# NanoClaw repository sync
kimbap agents sync --agent nanoclaw --dir /path/to/nanoclaw

Profile install locations:

Run kimbap agents sync any time you install new services to regenerate the discovery files.

Verify installation

kimbap doctor

doctor checks:

• Configuration file validity
• Data directory accessibility
• Vault status and key availability
• Services directory and installed manifests
• Policy file presence

To confirm actions are available and callable:

kimbap actions list
kimbap call github.list-repos --sort updated

Configuration reference

These environment variables control kimbap's runtime behavior. All can also be set in ~/.kimbap/config.yaml.

Next steps

• CLI Reference — all commands and flags
• Service Development — write your own YAML manifests
• Architecture — how the execution pipeline works