> For the complete documentation index, see [llms.txt](https://docs.kick.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kick.co/ai/cli/cli-quickstart.md).

# Quickstart

#### 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:**

| What You Run                                                                                                                                                                                                                   | The Value                                                                                                                            |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| <p><strong>Look up transactions</strong><br><code>kick --workspace \<workspace-id> transactions find --since 2026-01-01 --until 2026-01-31 --limit 25</code></p>                                                               | Pulls transactions for a date range so you can review or pipe them to another tool. **Read**                                         |
| <p><strong>Pull a profit and loss report</strong><br><code>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</code></p> | Returns P\&L data for one entity over a period. **Read**                                                                             |
| <p><strong>Switch client context</strong><br><code>kick workspaces list</code> then <code>kick workspaces use \<workspace-id></code></p>                                                                                       | Lists accessible workspaces and sets a default workspace for later commands. **Read** (list), **Write** (use stores a local default) |
| <p><strong>Update one transaction</strong><br><code>kick transactions update --transaction-id 12345 --payload-file transaction.json</code></p>                                                                                 | Applies a reviewed change to a single transaction after preview confirmation. **Write**                                              |

***

#### Why Use the CLI?

* **Automation:** Run the same lookup or export on a schedule
* **Integration:** Pipe JSON into spreadsheets, dashboards, or agent tools
* **Speed:** Batch review workflows without clicking through the UI
* **Version control:** Track scripts in Git alongside your firm's processes

***

#### Where to Start

<details>

<summary><strong>Step 1: Install Kick CLI</strong></summary>

**macOS/Linux and Windows:**

```bash
npm install -g @kickfinance/cli
```

**Verify installation:**

```bash
kick --help
```

→ [CLI installation guide](/ai/developer-tools/cli/install-the-kick-cli.md)

</details>

<details>

<summary><strong>Step 2: Authenticate</strong></summary>

For interactive use, sign in through the browser:

```bash
kick login
```

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

```bash
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](/ai/developer-tools/cli/authenticate-and-select-workspace.md)

</details>

<details>

<summary><strong>Step 3: Pick a workspace and verify access</strong></summary>

List workspaces you can access:

```bash
kick workspaces list
```

Run a command in a specific workspace:

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

Confirm the active user:

```bash
kick whoami
```

</details>

#### Documentation & Support

* **Scripting examples**: Browse verified automation scripts → [CLI Use Case Library](/ai/cli/cli-use-case-library.md)
* **API authentication**: Token management, permissions, and security → [Authentication Guide](/ai/developer-tools/cli/authenticate-and-select-workspace.md)
* **CLI reference**: Credentials, output modes, and command discovery → [CLI Reference](/ai/developer-tools/cli/cli-reference.md)


---

# 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-quickstart.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.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.