# Quickstart

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

| What You Run                                                                                                                                            | The Value                                                                              |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| <p><strong>Query transactions</strong><br><code>kick transactions list --workspace="Client Name" --date-range="last-quarter"</code></p>                 | Pulls matching transactions and displays them in your terminal or exports to CSV/JSON. |
| <p><strong>Generate reports</strong><br><code>kick reports pl --entity="ACME Corp" --period="2026-01"</code></p>                                        | Generates a profit & loss report and outputs formatted data.                           |
| <p><strong>Automate workflows</strong><br><code>kick rules create --condition="description contains 'AWS'" --category="Cloud Infrastructure"</code></p> | Creates an automation rule that runs on every new transaction.                         |
| <p><strong>Batch operations</strong><br><code>kick transactions update --file=updates.csv</code></p>                                                    | 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

<details>

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

**macOS/Linux:**

bash

```bash
curl -fsSL https://cli.kick.co/install.sh | sh
```

**Windows:**

powershell

```powershell
irm https://cli.kick.co/install.ps1 | iex
```

**Verify installation:**

bash

```bash
kick version
```

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

</details>

<details>

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

Generate an API token in Kick:

1. Go to Kick Settings → API
2. Click **Generate CLI token**
3. Copy the token (starts with `kick_cli_`)

Authenticate the CLI:

bash

```bash
kick auth login
```

Paste your token when prompted.

→ [Authentication Guide](/ai/developer-tools/cli/authenticate-and-select-workspace.md)

</details>

<details>

<summary><strong>Step 3: Verify Connection</strong></summary>

bash

```bash
kick workspaces list
```

If you see your workspaces, you're connected.

</details>

#### Documentation & Support

* **Scripting examples**: Browse real automation scripts and workflows → [CLI Use Case Library](/ai/kick-cli/cli-use-case-library.md)
* **API authentication**: Learn about token management, permissions, and security → [Authentication Guide](/ai/developer-tools/cli/authenticate-and-select-workspace.md)
* **CLI reference**: See all available commands, flags, and examples → [CLI References](/ai/developer-tools/mcp/references.md)


---

# Agent Instructions: 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:

```
GET https://docs.kick.co/ai/kick-cli/cli-quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.