cli use case library.md
Use Case Library
How to Use This Library
Each use case includes:
- The complete script you can copy and run
- Read or write label so you know whether the workflow changes data
- How to customize it for your needs
- What it outputs so you know what to expect
All scripts assume you have installed and authenticated the CLI. Replace <workspace-id>, entity ids, ledger ids, and dates with your client context.
Set a token for scripts:
export KICK_PAT=kick_pat_...
Workflow Scripts by Use Case
| Script | Description |
|---|---|
| Link 1 | Workflow 1 |
| Link 2 | Workflow 2 |
| Link 3 | Workflow 3 |
| Link 4 | Workflow 4 |
| Link 5 | Workflow 5 |
| Link 6 | Workflow 6 |
Quick Command Reference
List workspaces (read)
kick workspaces list
Set default workspace (write: stores local profile default)
kick workspaces use <workspace-id>
List entities in a workspace (read)
kick workspaces list --include-entities --output json
Find transactions in a date range (read)
kick --workspace <workspace-id> transactions find --since 2026-01-01 --until 2026-01-31 --limit 25
Export transactions as JSON (read)
kick --workspace <workspace-id> transactions find --since 2026-01-01 --until 2026-01-31 --fields id,date,amount,counterparty,category --output json
Profit and loss (read)
kick --workspace <workspace-id> reports profit-loss --entity 123 --ledger-id <ledger-uuid> --start-date 2026-01-01 --end-date 2026-01-31 --cycle month --output json
Balance sheet (read)
kick --workspace <workspace-id> reports balance-sheet --entity 123 --ledger-id <ledger-uuid> --start-date 2026-01-01 --end-date 2026-01-31 --output json
Trial balance (read)
kick --workspace <workspace-id> reports trial-balance --entity 123 --ledger-id <ledger-uuid> --start-date 2026-01-01 --end-date 2026-01-31 --output json
Resolve a ledger id for an entity (read)
kick --workspace <workspace-id> accounting ledgers get --entity-id 123 --output json
Inspect recent activity (read)
kick --workspace <workspace-id> activity list --resource-type transaction --limit 10 --output json
Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the ask query parameter, and the optional goal query parameter:
GET https://docs.kick.co/ai/cli/cli-use-case-library.md?ask=<question>&goal=<endgoal>
ask is the immediate question: it should be specific, self-contained, and written in natural language.
goal is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.