For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs; this page is available as Markdown.

CLI Troubleshooting

Use the symptom that matches what you see.

The kick command is not found

Check whether the CLI is installed:

kick --help

If the command is not found, install the CLI using your firm's instructions. If the CLI is installed but an app or agent cannot find it, use the absolute path to the binary.

No Kick credentials found

For interactive use:

kick login

Or provide a token:

export KICK_PAT=kick_pat_...
kick whoami

You can also pass a token directly for a single command:

kick --token kick_pat_... whoami

The wrong workspace is active

List available workspaces:

kick workspaces list

Then pass the workspace explicitly:

kick --workspace <workspace-id> transactions find --limit 10

If you use profiles, check the selected profile and its default workspace.

Auth or scope errors

Verify the token and workspace:

kick whoami
kick workspaces list

Then retry with an explicit workspace:

kick --workspace <workspace-id> transactions find --limit 10

If a write action fails, confirm that the token has write scope and the user has permission to perform that action in Kick.

CLI output is hard to parse

Use a machine-readable output mode:

kick transactions find --output json
kick transactions find --output json-compact
kick transactions find --output yaml

Diagnostics and errors are written to stderr so stdout can be piped safely:

kick transactions find --output json | jq '.[0].id'

A command returns too much data

Use list controls:

kick transactions find --limit 10
kick transactions find --fields id,date,amount,counterparty

When a command returns a next cursor, pass it to fetch the next page.

A write command returns a preview

This is expected for preview-first actions. Review the preview. If it matches your intent, repeat the call with the returned confirmation token or use the documented confirmation option for that command.

Do not automate confirmation unless the workflow has been reviewed and approved by your firm.