Introduction
kobana is a single command-line tool for the APIs of every Kobana product β the Kadu Agent included. It is built and maintained in its own repository (kobana-cli), not by this product, and has no hand-written endpoint at all: on startup it reads the OpenAPI 3.1 specs embedded in the binary and builds the command tree from them. Updating the API surface is a matter of updating the embedded spec and publishing a new build β no code per endpoint.
kobana <product> <resource> <method> [flags]
Built for people and AI agents alike: structured JSON output by default, schema introspection, --dry-run and automatic pagination. It has no shortcut the API lacks: token, scope, role and limits are the API's.
Productsβ
| Product | Description |
|---|---|
banking | Banking Gateway β charges, payments, transfers (API v1 and v2) |
finance | Smart Finance β accounts payable and receivable, transactions, cash flow |
billing | Automated Billing β subscriptions, plans, invoices, tax invoices |
inbox | Autonomous Inbox β inboxes, agents, emails, webhooks |
dunning | Collection Rules β rules, steps and dispatches |
dashboards | Magic Dashboard β dashboards and panels |
kadu | Kadu Agent β tasks, executions, pending items, environments, secrets, schedules and webhooks |
The kadu product talks to the same API documented on this site. Its resources β see the full catalog β point to the same endpoints as the API Reference; the CLI is just another way to call it. It does not share credentials with the other products: see Authentication.
Getting startedβ
-
Install β see Installation.
-
Authenticate with the product you will use. See Authentication.
-
Make the first call:
kobana kadu tasks list --fields "id,skill_slug,label" -
Explore the surface β every command accepts
--help, andkobana schemashows the parameters and body of any endpoint without leaving the terminal.
If the command says kadu is not a product, your CLI version predates Kadu: update it (kobana update or brew upgrade kobana).
Next stepsβ
- Installation β Homebrew, prebuilt binaries, Nix, build from source.
- Authentication β tokens, environments and the
kaducredentials. - Usage β syntax, resources, examples.
- Schema introspection β
kobana schemafor parameters and request/response shape. - Global flags β the flags every command accepts.
- Helpers β
+verbshortcuts for common flows. - Environment variables β authentication, configuration and logs.
- Exit codes β process exit codes, for scripts.