> ## Documentation Index
> Fetch the complete documentation index at: https://www.finta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Finta CLI

> Use Finta from your terminal, in scripts, and with coding agents

`finta` brings Finta's [REST API](https://www.finta.com/docs/api-reference/introduction.md) to your terminal. Every API endpoint is a command.

```bash theme={null}
finta transactions list --limit 5
finta export income-statement --start-date 2026-01-01 --end-date 2026-06-30
```

## Install

> [tab] macOS and Linux
>
> ```bash theme={null}
> curl -fsSL https://app.finta.com/install.sh | sh
> ```
>
> Run it again to update.

> [tab] Homebrew
>
> ```bash theme={null}
> brew install finta-public/finta/finta-cli
> ```

> [tab] npm (Windows)
>
> ```bash theme={null}
> npm install -g @fintahq/cli
> ```

The install script and Homebrew also set up tab completion. `finta` tells you when a newer version is out.

## Sign in

```bash theme={null}
finta login
```

Your browser opens. Sign in, choose a company, and click **Allow**. The CLI can do whatever your role in Finta allows, and needs **API access: Manage**.

* `--no-open` prints the sign-in link instead of opening a browser.
* `--with-api-key` signs in with an [API key](https://www.finta.com/docs/api-reference/introduction.md#get-your-api-key) instead. In CI, set `FINTA_API_KEY`.
* `finta whoami` shows the company you're signed in to. `finta logout` signs out.

New to Finta? Sign up with `finta signups create --email you@company.com`, click **Activate** in the email, run `finta login`, then `finta onboarding retrieve` to finish setting up.

## Commands

Each command is an API resource and an action: `GET /transactions` is `finta transactions list`. Run `finta --help` to see them all, and `--help` on any command for its flags.

```bash theme={null}
finta transactions update txn_123 --memo "Team offsite"
finta reports income-statement --start-date 2026-01-01 --end-date 2026-03-31
```

* `--all` fetches every page of a list.
* `-d, --data` sends a JSON body, for nested fields.
* `--dry-run` prints the request without sending it.
* `finta api <method> <path>` calls any API path, such as `finta api GET "/transactions?limit=5"`.
* `finta export` saves a report as a PDF, CSV or XLSX file, and `finta upload` imports transactions from a CSV.

New API endpoints show up as commands without updating `finta`.

## Output

In a terminal, lists print as tables. When output is piped, or with `--json`, you get the API's JSON:

```bash theme={null}
finta transactions list --status pending --all | jq length
```

## Confirmations

Deletes and other changes that can't be undone ask before they run. In a script or agent, pass `--yes` to confirm.

## Exit codes

| Code | Meaning |
| - | - |
| `0` | Success |
| `1` | The command failed |
| `2` | A usage error, or a change that needs `--yes` |
| `130` | Cancelled |

If a change times out, `finta` doesn't retry it. It tells you the command to check whether it went through.

## Coding agents

Coding agents like Claude Code, Codex and Cursor can run `finta` directly: they get JSON output and `--help` for every command. They should pass `--yes` only after you approve a change. To connect an AI app like Claude or ChatGPT instead, use the [MCP server](https://www.finta.com/docs/mcp/introduction.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.