Install
krabs is in v0.4. For now, install from source — clone the repo and run the setup script. Homebrew + npm distribution ship in v0.5.
From source (v0.4)
Three commands and you have an API + CLI on localhost:
git clone https://github.com/augusto-devingcc/krabs.git cd krabs pnpm install pnpm setup
pnpm setup creates a local SQLite database, mints an API key for you, and writes it to ~/.config/krabs/config.json. The CLI is now authenticated against your localhost instance.
Start the API server in another terminal:
pnpm dev:api
Verify everything by listing the contract:
./cli/dist/index.js schema describe # or after pnpm build:cli, just: krabs schema describe
v0.5. Until then, source install keeps the release surface small while we stabilize the contract. The flow above is what the published binary will run anyway.What you get
./cli/dist/index.js— the krabs CLI, a single ESM file (~66 KB)~/.config/krabs/config.json— your API URL + bearer token./data/krabs.db— local SQLite, your entire krabs state- An accounts row + an api_keys row, both visible if you query the DB directly
To put the CLI on your PATH as krabs, symlink it:
ln -s "$PWD/cli/dist/index.js" /usr/local/bin/krabs krabs --version
Coming in v0.5
The distribution paths that will work once the CLI is published:
# Homebrew brew install augusto-devingcc/krabs/krabs # npm npm install -g krabs-cli # Run without installing pnpm dlx krabs-cli auth login
Track the v0.5 milestone on the GitHub milestones page.
Uninstall
Delete the repo and wipe the local config + data:
rm -rf ~/path/to/krabs rm -rf ~/.config/krabs # remove the symlink if you created one: rm -f /usr/local/bin/krabs
Tokens live only on your disk. If you also created keys against the hosted api.krabs.dev, revoke them from the dashboard before uninstalling.
Next steps
- Quickstart → first call, three transports.
- Auth & tokens → how to mint, rotate, revoke.
- Self-hosting → running krabs entirely on your own infrastructure (no Clerk, no Turso).