Skip to main content
The CLI signs you in to Edgee and launches your agent through the gateway. Start with the agent quickstart for installation and your first verified session.

Choose a task

Launch an agent

Always give launch a target. Run edgee launch --help to see the targets supported by your installed version. For additional targets, OS requirements, and release availability, see apps and additional agents. Everything after the target is passed to the agent:
Edgee’s profile flag goes before the subcommand. Agent flags go after the target:
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.

Change agent settings

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 instead of repeatedly saving a local change.
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

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

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 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.
See configuration for environment overrides and self-hosted gateways, and plugins for centrally assigned skills and tools.