Quickstart
Run accounting workflows from your terminal. Query Kick data, generate reports, and automate bookkeeping tasks with command-line tools.
What Is Kick CLI?
Kick CLI is a command-line interface that connects to Kick's API. It lets developers and technical accountants work with Kick data directly from the terminal, no web browser required.
What you can do:
Query transactions
kick transactions list --workspace="Client Name" --date-range="last-quarter"
Pulls matching transactions and displays them in your terminal or exports to CSV/JSON.
Generate reports
kick reports pl --entity="ACME Corp" --period="2026-01"
Generates a profit & loss report and outputs formatted data.
Automate workflows
kick rules create --condition="description contains 'AWS'" --category="Cloud Infrastructure"
Creates an automation rule that runs on every new transaction.
Batch operations
kick transactions update --file=updates.csv
Updates multiple transactions from a CSV file in one command.
Why Use the CLI?
Automation: Script repetitive tasks like monthly report generation or transaction cleanup
Integration: Pipe Kick data into other tools, databases, or custom dashboards
Speed: Faster than clicking through the web UI for bulk operations
Version control: Track changes to rules, scripts, and workflows in Git
CI/CD pipelines: Integrate Kick operations into your deployment or reporting workflows
Where to Start
Step 1: Install Kick CLI
macOS/Linux and Windows:
npm install -g @kickfinance/cliVerify installation:
kick --helpStep 2: Authenticate
Generate an API token in Kick:
Go to Kick Settings → API
Click Generate CLI token
Copy the token (starts with
kick_cli_)
Authenticate the CLI:
Paste your token when prompted.
Documentation & Support
Scripting examples: Browse real automation scripts and workflows → CLI Use Case Library
API authentication: Learn about token management, permissions, and security → Authentication Guide
CLI reference: See all available commands, flags, and examples → CLI Reference
Last updated
Was this helpful?