Skip to content
Keboola Docs

kbagent command reference

Reference for the kbagent CLI — global flags, JSON output, every command group and its subcommands (project, config, job, storage, flow, sync, branch, workspace, token, agent), and error codes.

Every kbagent command lives in a group. This page lists the groups and their subcommands; run kbagent <group> --help for exact flags and kbagent context for the full machine-readable reference (built for AI agents — see Use with AI agents).

Available on every command:

FlagEffect
--json / -jMachine-readable output: { "status": "ok", "data": … }. Always use it for scripting/agents.
--verbose / -vVerbose logging.
--no-colorDisable colored output (auto-off in non-TTY).
--config-dirUse a specific config directory.
--deny-writesSession firewall: block all write, destructive, and admin operations.
--deny-destructiveSession firewall: block only data-destructive operations.
--allow-env-manage-tokenPermit reading KBC_MANAGE_API_TOKEN from the environment (default-deny).
Terminal window
$ kbagent --json project list
{ "status": "ok", "data": [ { "alias": "docs-demo", "project_name": "L0 - Shopify",
"project_id": 264, "stack_url": "https://connection.europe-west3.gcp.keboola.com",
"is_default": true, "org_id": 56 } ] }

init, doctor, version, update, changelog, context, repl, serve, permissions.

  • projectadd, list, remove, edit, status, use, current, info, refresh, invite, member-list, member-set-role, member-remove, invitation-list, description-get/set.
  • orgsetup (bulk-onboard projects / a whole organization).
  • tokencreate (scoped, shown once), refresh (rotate), delete (revoke).
  • feature — feature-flag management (super-admin Manage token).
  • search — find configs/tables/buckets/flows by name or content, across projects. Global Search by default; --search-type config-based scans configurations where Global Search isn’t enabled.

    kbagent search "shopify" --search-type config-based: a results table of matching configurations in docs-demo with type, ID, name, and component ID

  • configlist, detail, search, update, delete; rows (row-create/update/delete); variables (variables-set/get/clear); metadata; oauth-url.

  • joblist, detail, run, terminate.

  • storage — buckets, tables, and files (browse and manage).

  • lineage — cross-project, column-level data lineage: mermaid, HTML, or ER output, plus a local interactive viewer (lineage server).

    The kbagent lineage browser: an interactive graph of the demo project's pipeline — Shopify extractor tables flowing through two Snowflake transformations into BDM output tables, with input/output-mapping edges and upstream/downstream controls

  • component, data-app, stream, sharing, kai (beta — kai ask queries Kai from the shell).

  • flowlist, detail, schema, validate, new, update, delete, schedule, schedule-remove.
  • schedule — discover and audit cron schedules across projects.
  • branchlist, create, use, reset, delete, merge, plus branch metadata-*.
  • workspacecreate, list, detail, delete, password, load, query, from-transformation, gc.
  • syncinit, pull, status, diff, push, clone, branch-link/unlink/status.
  • encryptvalues (one-way encrypt #-prefixed secrets).
  • tool — call Keboola MCP tools directly.
  • agentscheduled AI agents: cron-driven agent tasks that run against your projects unattended (recipe): list, show, create, update, delete, run, runs, run-detail, run-events, test, prompt-improve, cron-preview.
  • semantic-layer, dev-portal, http.

With --json, failures return a stable string code you can branch on, grouped into categories (auth/access, network, API, configuration, jobs, storage, sync, and more) — for example INVALID_TOKEN, TIMEOUT, QUEUE_JOB_FAILED, UNKNOWN_ERROR. The full list is in the CLI’s docs/error-codes.md.

Terminal window
kbagent <group> --help # subcommands + flags for a group
kbagent context # complete reference (machine-readable, for agents)

Next: Web UI →

Ask Kai

Ask anything about Keboola — I'll search the docs and cite the pages I use.