Quickstart | AI & MCP | Kick Docs

What Is Kick CLI?

Kick CLI connects to Kick from your terminal. Use it to look up client data, pull reports, and script repeatable review workflows without opening the browser.

What you can do:

  1. Look up transactions
    kick --workspace <workspace-id> transactions find --since 2026-01-01 --until 2026-01-31 --limit 25
    Pulls transactions for a date range so you can review or pipe them to another tool. Read

  2. Pull a profit and loss report
    kick --workspace <workspace-id> reports profit-loss --entity 123 --ledger-id <ledger-uuid> --start-date 2026-01-01 --end-date 2026-01-31 --output json
    Returns P&L data for one entity over a period. Read

  3. Switch client context
    kick workspaces list then kick workspaces use <workspace-id>
    Lists accessible workspaces and sets a default workspace for later commands. Read (list), Write (use stores a local default)

  4. Update one transaction
    kick transactions update --transaction-id 12345 --payload-file transaction.json
    Applies a reviewed change to a single transaction after preview confirmation. Write

Why Use the CLI?

Where to Start

Step 1: Install Kick CLI

macOS/Linux and Windows: 

npm install -g @kickfinance/cli

Verify installation:

kick --help

→ CLI installation guide

Step 2: Authenticate

For interactive use, sign in through the browser:

kick login

For scripts, set a personal access token (prefix kick_pat_):

export KICK_PAT=kick_pat_...
kick whoami

The CLI resolves credentials from --token, KICK_PAT, KICK_API_TOKEN, your OS keychain, or ~/.config/kick/credentials.

→ Authentication Guide

Step 3: Pick a workspace and verify access

List workspaces you can access:

kick workspaces list

Run a command in a specific workspace:

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

Confirm the active user:

kick whoami

Documentation & Support