SettleKit CLI

SettleKit is a CLI-first tool platform for developers, scripts, and AI agents. It uses your SettleMesh-backed SettleKit account to discover tools, call capabilities, upload temporary media inputs, and check credits from one command.

Install

For AI agents, clean terminals, and project-specific deploys, prefer a project-local latest install. This avoids stale global settle binaries:

npm install settlekit@latest --prefer-online
./node_modules/.bin/settle doctor --require-latest
./node_modules/.bin/settle recipes

Global install is also supported for interactive use:

npm install -g settlekit
settle doctor

The package exposes three aliases:

settle --version
settlekit --version
kit --version

Project-local install also works:

npm install settlekit@latest --prefer-online
./node_modules/.bin/settle help

Login

settle login

For CI, scripts, and hosted agents:

export SETTLE_API_KEY="sk_..."

Use SETTLE_BASE_URL=http://localhost:8080 for local development, and SETTLE_REQUEST_TIMEOUT=90s for slow provider calls.

Use Tools

Always use discovery before calling tools:

settle help --json
settle recipes
settle tool list --json
settle tool show web.search --json

For a no-context agent, start with the built-in golden paths:

npm install settlekit@latest --prefer-online
./node_modules/.bin/settle doctor --require-latest
./node_modules/.bin/settle recipes
./node_modules/.bin/settle search "build app with login database api command"
./node_modules/.bin/settle services show app-project-backends --json

settle recipes covers the shortest flows for full-stack app deploys, App API/CLI commands, browser bridge URLs, hosted agents, and local worker offers.

Call a tool with JSON input:

settle tool call web.search \
  --input '{"q":"SettleKit","count":5}' \
  --json

Generate an image task:

settle tool call image.gpt-image-2 \
  --input '{"prompt":"A clean product photo of a ceramic tea cup","size":"1:1"}' \
  --json

Poll async media:

settle tool events image_... --json

Upload a local image for image-to-image:

settle files upload ./input.png --json
settle tool call image.gpt-image-2 \
  --input '{"prompt":"Turn this into a clean product photo","size":"1:1"}' \
  --image-file ./input.png \
  --json

Credits

settle credits balance --json
settle credits ledger --json
settle credits topup --credits 100 --json

Hosted Agents

Create from a built-in template and make it callable by other accounts:

settle agents templates --json
settle agents create \
  --name research-helper \
  --template hermes \
  --public \
  --max-budget 50 \
  --allowed-capabilities web.search,web.scrape,llm.chat \
  --json
settle agents invoke agent_... --input '{"prompt":"Find three primary sources."}' --json

You can share the returned agent_id; other users can call public agents directly by id with settle agents invoke or settle tool call agent.invoke.

Managed Backends

Create a SettleKit project with database + app auth:

settle projects create --name demo --db sqlite --auth email_password,magic_link
settle db query proj_... --sql "select 1"
settle db migrate proj_... --file schema.sql
settle db connection proj_...
settle auth users proj_...

settle db connection is redacted by default. Add --reveal only in a trusted terminal. Database SQL endpoints accept a developer key or the one-time project server key returned by projects create; browser/public project keys are only for app auth.

Full-stack Apps, App APIs, and CLI Commands

Deploy a local app project with SettleMesh auth, database, runtime API keys, and optional payment bindings:

./node_modules/.bin/settle deploy ./my-next-app --name my-next-app --full-stack --wait --json

Expose selected routes from that app as APIs and CLI commands:

settle apps api publish app_... --file app-api.json --json
settle apps api call app_... summarize --input '{"topic":"shipping"}' --json
settle apps commands publish app_... --file app-commands.json --json
settle run app:app_....summarize --input '{"topic":"shipping"}' --open --json

When a command has a web binding, --open can return a short-lived URL that opens the app in the browser using the caller's Settle login, without a second manual login.

Local Worker Offers

Share a local OpenAI-compatible endpoint as a callable service:

settle search "lend local compute worker offer"
settle worker start --name local-model --public --model local/model --endpoint http://localhost:11434/v1/chat/completions --credits-per-second 0.05
settle worker-offers list --json

Public Tool Surface

The public CLI surface includes discovery, tools, full-stack app deployment, App APIs/commands, hosted agents, local worker offers, credits, files, and managed project/database/auth operations. Provider-specific operations may still be gated on a given deployment. Inspect each tool's availability, policy, and input_schema before side-effecting or costly calls.