Advanced Scripting | AI & MCP | Kick Docs

For the complete documentation index, see llms.txt. This page is also available as Markdown.

Most lookup commands accept --output json or --output json-compact for parsing with jq:

Command Examples

Get transaction count by category (read):

kick --workspace <workspace-id> transactions find --output json | \
  jq 'group_by(.category) | map({category: .[0].category, count: length})'

Find largest transactions (read):

kick --workspace <workspace-id> transactions find --fields id,date,amount,counterparty --output json | \
  jq 'sort_by(.amount) | reverse | .[0:10]'

Calculate average amount by counterparty (read):

kick --workspace <workspace-id> transactions find --fields amount,counterparty --output json | \
  jq 'group_by(.counterparty) | map({counterparty: .[0].counterparty, avg: (map(.amount) | add / length)})'

Credentials and workspace defaults

For scripts, set a personal access token:

export KICK_PAT=kick_pat_...
kick whoami

To avoid repeating --workspace on every command, set a local default:

kick workspaces use <workspace-id>

Or store the default on a named profile:

kick config set profiles.acme.defaultWorkspaceId <workspace-id>
kick config set defaultProfile acme
kick --profile acme whoami

Config is stored locally (not in ~/.kick/config.yaml). Inspect it with:

kick config get

Pass --workspace <workspace-id> explicitly when you work across multiple clients in one script. That is safer than relying on a remembered default.

Output modes

--output auto — table in a terminal, structured output when piped
--output table — human-readable table
--output json — formatted JSON on stdout
--output json-compact — compact JSON for agents and scripts
--output yaml — YAML

Diagnostics and errors go to stderr, so you can pipe stdout safely:

kick --workspace <workspace-id> transactions find --limit 10 --output json | jq '.[0].id'

Scheduling Scripts

Run read-only lookup scripts with cron (Linux/Mac):

# Edit crontab
crontab -e

# Daily at 9am: Uncategorized transaction alert
0 9 * * * /path/to/daily-uncategorized-alert.sh

# First day of month: Generate monthly P&L JSON
0 8 1 * * /path/to/monthly-pl-reports.sh

# Every Monday: Export to warehouse
0 10 * * 1 /path/to/export-to-warehouse.sh

For Windows, use Task Scheduler.

Review write commands manually before scheduling them. Commands that change data require preview confirmation and should not run unattended unless your firm has approved that workflow.