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

# Edgee CLI

> Launch agents, manage your login and organization, configure settings, and inspect usage.

The CLI signs you in to Edgee and launches your agent through the gateway. Start with the [agent quickstart](https://www.edgee.ai/docs/quickstart/index.md) for installation and your first verified session.

## Choose a task

| I want to… | Command or guide |
| - | - |
| Launch an agent | `edgee launch claude`, `edgee launch codex`, or another target below |
| Check my account | `edgee auth status` |
| Change organization or profile | [Authentication and profiles](https://www.edgee.ai/docs/cli/authentication.md) |
| Change compression or routing | `edgee settings` or `edgee settings claude` |
| Read recent usage | `edgee stats` |
| See assigned plugins | `edgee plugins` |
| Show usage inside Claude Code | [Statusline](https://www.edgee.ai/docs/cli/statusline.md) |
| Launch without typing Edgee each time | [Aliases](https://www.edgee.ai/docs/cli/aliases.md) |
| Update Edgee | `edgee update` (`edgee self-update` is an alias) |
| Diagnose a problem | [Troubleshooting](https://www.edgee.ai/docs/troubleshooting.md) |

## Launch an agent

```bash theme={"dark"}
edgee launch claude
edgee launch codex
edgee launch opencode
```

Always give `launch` a target. Run `edgee launch --help` to see the targets supported by your installed version.

| Target | Application |
| - | - |
| `claude` | Claude Code |
| `codex` | Codex CLI |
| `opencode` | OpenCode |
| `codebuddy` | CodeBuddy |
| `crush` | Crush |
| `pi` | Pi |
| `kimi` | Kimi Code |
| `kilo` | Kilo Code CLI |
| `cursor` | Cursor editor |
| `copilot-vscode` | GitHub Copilot in VS Code |
| `omp` | [Oh My Pi](https://www.edgee.ai/docs/agents/omp.md) |
| `copilot-cli` | [GitHub Copilot CLI](https://www.edgee.ai/docs/agents/copilot-cli.md) |
| `intellij` | [GitHub Copilot in IntelliJ IDEA](https://www.edgee.ai/docs/agents/copilot-intellij.md) **Beta** |
| `copilot-desktop` | [GitHub Copilot Desktop](https://www.edgee.ai/docs/agents/copilot-desktop.md) **Beta** |
| `claude-desktop` | [Claude Desktop](https://www.edgee.ai/docs/agents/claude-desktop.md) **Beta** |
| `codex-desktop` | [Codex Desktop](https://www.edgee.ai/docs/agents/codex-desktop.md) **Beta** |

For additional targets, OS requirements, and release availability, see [apps and additional agents](https://www.edgee.ai/docs/cli/apps.md).

Everything after the target is passed to the agent:

```bash theme={"dark"}
edgee launch claude --resume
edgee launch codex --help
```

Edgee's profile flag goes **before** the subcommand. Agent flags go after the target:

```bash theme={"dark"}
edgee -p work launch claude --resume
```

The CLI can prompt for login and connection mode on first launch. After a session with model traffic, it prints a report link. See [Sessions](https://www.edgee.ai/docs/features/observability/sessions.md).

## Change agent settings

```bash theme={"dark"}
edgee settings
edgee settings claude
```

Choose the agent, then follow the menu to change its available compression and routing settings. These are settings for the selected organization's agent key, not a separate local routing policy.

Organization and squad rules can lock a setting. If an option cannot be changed, check [Gateway settings and inheritance](https://www.edgee.ai/docs/features/organization.md) instead of repeatedly saving a local change.

> [!NOTE]
>
> Settings target names can differ from launch names: use `copilot` for settings and `copilot-vscode` to launch VS Code. Run `edgee settings --help` for your installed version's accepted names.

**Verify:** launch a fresh request and inspect it in **Logs**. Changing a setting does not rewrite past sessions.

## Inspect usage

```bash theme={"dark"}
edgee stats
edgee stats --limit 5
edgee stats --json --period 7d
edgee stats --json --local
```

The human-readable report uses stored session reports. JSON output can retrieve your usage from the API when signed in; `--local` uses this machine's stored reports. Inspect the JSON `source` field before comparing results across devices. `edgee report` is an alias for `edgee stats`.

## Update and reconnect

```bash theme={"dark"}
edgee --version
edgee update
```

If you installed with Homebrew, you can use `brew upgrade edgee-ai/tap/edgee`. Builds without the self-update feature may not expose `update`.

Use `edgee auth login` to sign in again. `edgee reset` restarts the login flow; it is not the command to uninstall aliases. Use `edgee auth logout` to clear the active profile's login, and [alias removal](https://www.edgee.ai/docs/cli/aliases.md) to restore ordinary agent launch commands.

## Configuration and help

The CLI manages profiles in `~/.config/edgee/credentials.toml`. The file contains credentials: do not paste it into an issue or commit it. Prefer CLI commands to manual edits.

```bash theme={"dark"}
edgee --help
edgee auth --help
edgee settings --help
edgee plugins --help
```

See [configuration](https://www.edgee.ai/docs/cli/configuration.md) for environment overrides and self-hosted gateways, and [plugins](https://www.edgee.ai/docs/features/plugins.md) for centrally assigned skills and tools.


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