# Runsite CLI — deploy from your terminal

> Deploy services, read logs and set environment variables on Runsite from your terminal. Install the runsite CLI on macOS, Linux or Windows, or run it in CI with an API key.

1. [Home](/)
2. [Tools](/tools)
3. CLI

runsite v0.1.0

# Deploy without leaving the terminal

A single binary that talks to the same API as the dashboard. Ship a service, read its logs, change an environment variable — from your shell or from a build pipeline.

`curl -fsSL https://runsite.app/install.sh | sh`

Installs to \~/.local/bin/runsite. Add that directory to your PATH if the installer says it is missing.

[Read the docs](https://docs.runsite.app/cli/overview)[Source and releases](https://github.com/runsite-platform/runsite-cli)

bash — runsite

 v0.1.0

 runsite deploy api

 building 8e4c1a2 on main .......... 24.1s

 health check /healthz ........... 200 OK

 released in 38s

 runsite logs api --tail 3

 INFO  listening on 0.0.0.0:8080

 INFO  migrations up to date

 INFO  GET /healthz 200 1.4ms 

Same API as the dashboard, running in Germany

## What you can do with it

Name a service to act on it, or leave the name out when there is only one — the CLI resolves it for you. Every command that prints data also accepts `--output json`.

### Sign in

One API key per machine, stored in your config file.

`runsite login`

Sign in with email and password, mint a key for this machine

`runsite login --token ak_live_…`

Use a key you created in the dashboard

`runsite whoami`

Show the account the current key belongs to

`runsite logout`

Remove the key from this machine

### Run services

The same start, stop and restart the dashboard performs.

`runsite service list`

Every service, its status and its URL

`runsite service status api`

Branch, instances and last change for one service

`runsite service start api`

Bring a stopped service back up

`runsite service stop api`

Stop a service and stop billing it

`runsite service restart api`

Roll the running containers

### Ship changes

Deploy the current branch and read what the container printed.

`runsite deploy api`

Build and release the latest commit

`runsite logs api --tail 200`

Recent container output

### Configure

Environment variables take effect on the next deploy or restart.

`runsite env list api`

Every variable set on a service

`runsite env set api LOG_LEVEL=debug`

Add or update one or more variables

`runsite env delete api LOG_LEVEL`

Remove variables

### Move between projects

Profiles keep separate accounts and environments apart.

`runsite project list`

Projects on the account

`runsite project use billing`

Resolve service names inside one project

`runsite context show`

Active profile, API URL and project

`runsite completions zsh`

Shell completions for bash, zsh or fish

## Install it your way

The installers pick the right binary for your machine and check it against the release's SHA-256 manifest before unpacking it. Prefer to do that by hand? Grab an archive from the releases page.

| Platform | Architecture  | Archive                                           |
| -------- | ------------- | ------------------------------------------------- |
| Linux    | x86\_64       | runsite-v0.1.0\-x86\_64-unknown-linux-musl.tar.gz |
| Linux    | ARM64         | runsite-v0.1.0\-aarch64-unknown-linux-musl.tar.gz |
| macOS    | Intel         | runsite-v0.1.0\-x86\_64-apple-darwin.tar.gz       |
| macOS    | Apple silicon | runsite-v0.1.0\-aarch64-apple-darwin.tar.gz       |
| Windows  | x86\_64       | runsite-v0.1.0\-x86\_64-pc-windows-msvc.zip       |

Pin a version with `RUNSITE_VERSION=v0.1.0` or change the target directory with `RUNSITE_INSTALL_DIR`. Every archive is listed on the [releases page](https://github.com/runsite-platform/runsite-cli/releases).

## The same binary in CI

Create an API key in the dashboard, store it as a pipeline secret, and set `RUNSITE_API_TOKEN`. No interactive sign-in, no browser step. The key carries the permissions you gave it and you can revoke it at any time.

.github/workflows/deploy.yml

```
- name: Deploy to Runsite
  env:
    RUNSITE_API_TOKEN: ${{ secrets.RUNSITE_API_TOKEN }}
  run: |
    curl -fsSL https://runsite.app/install.sh | sh
    ~/.local/bin/runsite deploy api
```

FAQ

## Frequently Asked Questions

Common questions about this service.

### Do I need a password to use the CLI?

No. If you sign in to Runsite with Google or GitHub, create an API key under Settings → API keys in the dashboard and run \`runsite login --token ak\_live\_…\`. Accounts with a password can run plain \`runsite login\`, which mints a key for that machine automatically.

### How do I use the CLI in CI?

Set RUNSITE\_API\_TOKEN to an API key in your pipeline secrets and skip \`runsite login\` entirely. Every command reads that variable in preference to the stored key, so the same binary works unchanged on a laptop and on a build runner.

### Where does the CLI store my credentials?

In \~/.config/runsite/config.toml on macOS and Linux, and %APPDATA%\\runsite\\config.toml on Windows. The file holds one API key per profile. \`runsite logout\` deletes the local copy; the key itself stays valid until you revoke it in the dashboard.

### Can I manage more than one account?

Yes. Every command accepts \`--profile <name>\`, or reads RUNSITE\_PROFILE. Each profile keeps its own API URL, key and selected project, so a personal account and a work account can live side by side.

### Is the download verified?

Both installers fetch the release's SHA256SUMS.txt and refuse to install a binary whose digest does not match. You can also download an archive from the releases page and check it yourself with sha256sum.

### Can I open a shell in a container from the CLI?

Not yet. \`runsite shell\`, \`runsite run\` and streaming build logs need a live WebSocket connection, which the public API does not expose to API keys at the moment. Use the dashboard for an interactive shell and for watching a build as it happens.

## Your app deserves to be online

€5 of credit on signup. Deploy in under a minute. No credit card needed.

[Start deploying](https://dashboard.runsite.app/login)[View documentation](https://docs.runsite.app)

---

Source: https://runsite.app/tools/cli
