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

# Overview

> Install the xpander CLI, authenticate, and run your first command.

The xpander CLI is your command-line for managing agents, scaffolding local projects, and deploying containers to xpander.ai's cloud. It covers four areas:

| Area                  | What it does                                                    |
| --------------------- | --------------------------------------------------------------- |
| **Control plane**     | Create, edit, delete, invoke agents in the cloud.               |
| **Local development** | Scaffold framework templates and run agents locally.            |
| **Cloud deployment**  | Build and deploy Docker containers, stream logs, restart, stop. |
| **NeMo sync**         | Pull/push agent model configuration to/from local NeMo config.  |

## Install

**Requirements:** Node.js 20+, Python 3.12+.

```bash theme={"dark"}
npm install -g xpander-cli
```

Verify the install:

```bash theme={"dark"}
xpander --version
```

Authenticate (opens a browser):

```bash theme={"dark"}
xpander login
```

Or set credentials manually:

```bash theme={"dark"}
xpander configure
```

Credentials are stored at `~/.xpander/credentials` and scoped per profile (default profile is `default`).

## First command

```bash theme={"dark"}
xpander agent new
```

The wizard prompts for a name, creates the agent in your org, and offers to load the framework template into the current directory.

## Global options

These apply to every command (and to `xpander` itself):

| Flag                | Description                                                                                      |
| ------------------- | ------------------------------------------------------------------------------------------------ |
| `-v, --version`     | Print the CLI version and exit.                                                                  |
| `--output <format>` | Output format: `json` or `table`. Defaults to `table`.                                           |
| `--profile <n>`     | Profile to use. Falls back to the active profile.                                                |
| `--api-key <key>`   | Override the active profile's API key for this command.                                          |
| `-y, --yes`         | Auto-answer "yes" to every prompt (non-interactive mode).                                        |
| `--no-interactive`  | Disable interactive prompts. Commands fail if a required input is missing rather than prompting. |
| `-h, --help`        | Print help for the current command.                                                              |

## Top-level commands

| Command                        | Alias | Purpose                                                           |
| ------------------------------ | ----- | ----------------------------------------------------------------- |
| `xpander configure`            | `c`   | Set up API credentials.                                           |
| `xpander login`                | `l`   | Authenticate via browser.                                         |
| `xpander profile`              | –     | Manage profiles.                                                  |
| `xpander agent`                | `a`   | Manage agents (full namespace: see Agent Commands).               |
| `xpander deploy [agent]`       | `d`   | Shortcut for `agent deploy`.                                      |
| `xpander restart [agent]`      | –     | Shortcut for `agent restart`.                                     |
| `xpander stop [agent]`         | –     | Shortcut for `agent stop`.                                        |
| `xpander initialize [agent]`   | `i`   | Shortcut for `agent init`.                                        |
| `xpander dev [agent]`          | –     | Shortcut for `agent dev`.                                         |
| `xpander logs [agent]`         | –     | Shortcut for `agent logs`.                                        |
| `xpander invoke [agent] [msg]` | –     | Shortcut for `agent invoke`.                                      |
| `xpander secrets-sync`         | –     | Sync local `.env` to deployed agent.                              |
| `xpander nemo`                 | –     | Sync agent model config with local NeMo config (`pull` / `push`). |
| `xpander help [command]`       | –     | Print help for a command.                                         |

Most lifecycle commands exist both as top-level shortcuts (`xpander deploy`) and inside the `agent` namespace (`xpander agent deploy`). Both forms are documented in [Agent Commands](/developers/cli-reference/agent-commands).

## Where to next

<CardGroup cols={2}>
  <Card title="Agent Commands" icon="robot" href="/developers/cli-reference/agent-commands">
    Every command under `xpander agent`: control plane, local dev, deployment, graph, tools, NeMo.
  </Card>

  <Card title="Auth & Config" icon="key" href="/developers/cli-reference/auth-config">
    `login`, `configure`, `profile`, `secrets-sync`.
  </Card>

  <Card title="Shortcuts" icon="bolt" href="/developers/cli-reference/shortcuts">
    `x a n`, `x a d`, and friends.
  </Card>
</CardGroup>