# Overview

> Source: https://truto.one/docs/cli/overview/

The Truto CLI is the command-line interface for the Truto unified API platform. Use it to manage platform resources (integrations, accounts, sync jobs, webhooks, and more), call unified and proxy APIs against live connections, bulk-export data, and scaffold integrations with AI-assisted builds.

## What you can do

| Area                   | Examples                                                                         |
| ---------------------- | -------------------------------------------------------------------------------- |
| **Authentication**     | `truto login`, profiles for staging vs production                                |
| **Integrations**       | List, create, update; AI-powered `integrations build`; push configs with `apply` |
| **Connected accounts** | `truto accounts list`, refresh OAuth, mint scoped tokens                         |
| **Automation**         | Sync jobs, workflows, webhooks, daemon jobs                                      |
| **Data plane**         | `truto unified`, `truto proxy`, `truto custom`, `truto batch`                    |
| **Power tools**        | `export`, `diff`, `jsonata eval`, open resources in the dashboard                |

## Before you begin

You need three things before the CLI can talk to Truto:

| Requirement       | What it is                                           | How to get it                                                                                        |
| ----------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Truto account** | Access to the dashboard and your team                | [Sign in](https://app.truto.one) or ask your team admin for an invite                                |
| **API token**     | A secret Bearer credential scoped to one environment | Create one in the dashboard — see [Creating API tokens](/docs/guides/api-tokens/creating-api-tokens) |

:::callout{type="info"}
Each API token belongs to a **single environment**. Commands only see integrations, accounts, and other resources in that environment. Use separate [CLI profiles](/docs/cli/authentication#profiles) if you work across staging and production.
:::

## Quick start

### 1. Install the CLI

```bash
curl -fsSL https://cli.truto.one/install.sh | bash
```

The installer places `truto` in `~/.truto/bin`. If `truto` is not found, add that directory to your `PATH` (the install script usually prints the exact line to run), then open a new terminal tab.

See [Installation](/docs/cli/installation) for version pinning and upgrades.

### 2. Log in

**Interactive** — the CLI prompts for profile name, API URL, and token:

```bash
truto login
```

**Non-interactive** — pass the token you copied from the dashboard:

```bash
export TRUTO_API_TOKEN="<paste-your-token-here>"
truto login --token "$TRUTO_API_TOKEN"
```

Leave the API URL at the default (`https://api.truto.one`) unless your team uses a custom instance.

Details: [Authentication](/docs/cli/authentication).

### 3. Verify

```bash
truto whoami
```

You should see your **profile**, **API URL**, **team name**, and the **environment** your token is scoped to.

### 4. Explore your environment

```bash
# Integrations installed in this environment (not the global catalog)
truto integrations list

# API tokens you can inspect (create/delete still requires the dashboard)
truto api-tokens list
```

**Next commands to try:**

```bash
truto accounts list                    # connected customer accounts
truto integrations list --name hubspot # filter by slug
truto open integrations                # open the dashboard in your browser
```

For a full product walkthrough (Link, webhooks, first unified call), continue with [Getting started](/docs/getting-started).

## Documentation map

| Topic                               | Page                                             |
| ----------------------------------- | ------------------------------------------------ |
| Install and upgrade                 | [Installation](/docs/cli/installation)           |
| Login, profiles, tokens             | [Authentication](/docs/cli/authentication)       |
| Flags and output formats            | [Global options](/docs/cli/global-options)       |
| Integrations (CRUD, apply, lint)    | [Managing integrations](/docs/cli/integrations)  |
| AI build from docs                  | [AI-powered build](/docs/cli/integrations-build) |
| Add one method (you supply details) | [Add method](/docs/cli/integrations-add-method) |
| Accounts, sync jobs, webhooks, etc. | [Admin resources](/docs/cli/admin-resources)     |
| Unified, proxy, custom, batch       | [Data plane](/docs/cli/data-plane)               |
| Export, diff, JSONata, open         | [Power features](/docs/cli/power-features)       |
| Guided wizard                       | [Interactive mode](/docs/cli/interactive-mode)   |
| Full command list                   | [Command reference](/docs/cli/command-reference) |
| Cookbook examples                   | [Examples](/docs/cli/examples)                   |

## Related resources

- [Getting Started](/docs/getting-started) — first API call and dashboard setup
- [Guides](/docs/guides/how-truto-works/overview) — platform concepts
- [API Reference](/docs/api-reference/overview/introduction) — REST endpoints the CLI wraps
- [TypeScript SDK](/docs/sdks/typescript) — programmatic alternative to the CLI

:::callout{type="tip"}
Coding agents can run `truto context` for a single-shot reference of every command, flag, and entity. Add `--full` for the auto-generated command tree.
:::
