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

# Upsun Cloud CLI

> Install and use the Upsun Cloud CLI to manage your projects directly from the terminal

# Upsun Cloud CLI

The full power of Upsun Cloud in your terminal. Manage projects, push code, SSH into environments, and automate workflows.

[Install](https://developer.upsun.com/cli/install.md)

[Command Reference](https://developer.upsun.com/cli/reference.md)

\~/my-project

\$upsun
Welcome to Upsun Cloud!

\$upsun push

Pushing HEAD to branch feature-login...\

Building application 'myapp'...\

✓ Environment deployed: [https://feature-login-abc123.upsun.app](https://feature-login-abc123.upsun.app)

\$upsun ssh

Connected to myapp\@feature-login (us-5)\

app\@feature-login:\~\$ \_

## CLI Documentation

Learn how to install, configure, and use the Upsun Cloud CLI.

> [card] [Install](https://developer.upsun.com/cli/install.md)
>
> Install and authenticate the CLI

> [card] [Use](https://developer.upsun.com/cli/use.md)
>
> Run commands and customize the CLI

> [card] [API Tokens](https://developer.upsun.com/cli/api-tokens.md)
>
> Authenticate for CI/CD and automation

> [card] [Init](https://developer.upsun.com/cli/init.md)
>
> Set up a project from a repository

> [card] [Reference](https://developer.upsun.com/cli/reference.md)
>
> All CLI commands and options

> [card] [AI Agents](https://developer.upsun.com/cli/ai-coding-agents.md)
>
> Manage projects with AI coding agents

1

## Install

Choose your platform

```bash macOS (Homebrew) theme={null}
  brew install upsun/tap/upsun-cli
```

```bash Linux theme={null}
  curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | bash
```

```bash Windows (Scoop) theme={null}
  scoop bucket add upsun https://github.com/upsun/homebrew-tap.git
  scoop install upsun
```

Windows (Scoop) requires the [Extras bucket](https://github.com/ScoopInstaller/Extras)

2

## Authenticate

Log in via your browser

<pre>
  `$ upsun
  Opening a browser to log in...
  ✓ Login successful.
  ✓ SSH certificates created.

  Your projects:   [0] My project (xb3pfo734qxbeg)   [1] Another project (3p5fmol45kxp6)`
</pre>

Running `upsun` opens a browser login flow and generates SSH certificates for secure access.

Use `upsun login` to force a re-authentication.

For CI/CD pipelines and automation, use [API tokens](https://developer.upsun.com/cli/api-tokens.md) instead.

3

## Use

Common commands

upsun list

upsun help get

upsun push

upsun ssh

upsun ssh -- python my-script.py

upsun get PROJECT\_ID

upsun environment:info

upsun merge

upsun tunnel:open

## AI Coding Agents

Teach your AI coding agent to manage Upsun Cloud projects using the CLI.

### Upsun plugin

The [Upsun plugin](https://github.com/upsun/ai) is an open-source plugin for AI coding agents like [Claude Code](https://claude.ai/download) and Cursor. It bundles an `upsun` skill that guides your agent through Upsun Cloud CLI workflows — deployments, environments, backups, databases, scaling, and more — and the [Upsun Cloud MCP server](https://developer.upsun.com/docs/get-started/ai/using-the-mcp.md).

Install as a Claude Code plugin

claude plugin marketplace add upsun/ai
claude plugin install upsun\@upsun

Or install for other agents via skills.sh

npx skills add https\://github.com/upsun/ai --skill upsun

What your agent can do

Deploy & manage environmentsPush, branch, merge, and sync with production safety patterns

Backup & restoreCreate backups, verify integrity, and restore with confirmation checks

Database operationsConnect to and manage database services

Scale & configureAdjust resources, manage domains, and configure autoscaling

[View on GitHub](https://github.com/upsun/ai)

## Features

Everything you need to manage projects, environments, and deployments from the terminal.

### Auto-detection

Detects project and environment from your local checkout. Override with `--project` and `--environment`.

### More than Git

Commands like `upsun push` add options like `--activate` and `--no-wait`.

### Customizable

Configure via `~/.upsun-cli/config.yaml`. See [GitHub](https://github.com/upsun/cli/blob/main/docs/configuration.md).

### Automation-ready

Set `UPSUN_CLI_NO_INTERACTION=1` to bypass prompts in CI/CD.

### Autocompletion

Enable tab completion with `eval $(upsun completion)` or via [Homebrew](https://docs.brew.sh/Shell-Completion).

### SSH built-in

Creates SSH certificates automatically on login. Access environments with `upsun ssh`.

## Maintenance

Keep your CLI up to date and resolve common issues.

### Update

brew upgrade upsun-cli

scoop update upsun

### Troubleshooting

RootNotFoundExceptionIf you cloned via Git directly, run:

upsun project:set-remote --project PROJECT\_ID

Upgrading from legacy CLI? Follow the [installation steps](https://developer.upsun.com/cli/install.md) — the new CLI guides you through removal.

## Ready to get started?

Install the CLI and start managing your projects from the terminal.

[Install the CLI](https://developer.upsun.com/cli/install.md)

[View Reference](https://developer.upsun.com/cli/reference.md)


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