Skip to content

Control Panel

canopy ui (or just canopy, in a terminal) opens the Control Panel: a full-screen terminal interface that shows what needs attention and lets you move between projects, environments, builds and logs without remembering command names. It uses the same API and the same permissions as the commands, so it shows what you can already see with the CLI.

It needs an interactive terminal, Node 22 or later, and a profile you have logged in with (canopy login). Run without a terminal, or with TERM unset or dumb, canopy ui explains why it did not open and points at canopy --help. Plain canopy quietly prints the help instead, as it always did, whenever the panel cannot open (piped output, CI, a small terminal, not logged in); set CANOPY_NO_TUI=1 to always get the help. NO_COLOR turns colour off and the panel still opens. Every other command works as before.

  • Home: what needs attention (broken or behind environments), builds running now, and recent builds. Enter opens the environment or build.
  • Projects: every project with its environments. f filters the list.
  • Project: its environments with deploy state, release and last build, then the newest builds across all of them.
  • Environment: services with replicas and restarts, the resources it uses, the latest build and any problems. Enter on a service opens its detail: kind, source, commands, network, sizing, bindings and runtime state, with its logs one key away.
  • Builds: an environment’s builds, newest first. A build that is still running shows how long it has been running.
  • Build: the commit, timing and log. A running build follows its log live and stops when you leave. t cycles between the log, the pipeline and the platform activity (provisioning, route admission, certificates). The pipeline shows each node with status, time, cache hits, retries and errors, then the deploy steps. . cancels a running build (type its number), retries a failed one, approves or rejects a deploy waiting for approval, approves or rejects a pipeline gate that is waiting, and runs the pipeline again.
  • Releases: an environment’s releases with the active one marked. . on a superseded release offers a rollback.
  • Variables: the environment’s variables, secrets shown as (secret), system variables last. . sets, changes or deletes one, and shows one secret’s value in its own pane when you ask (it is forgotten when you close the pane).
  • Autoscaling: each process with its replicas, measured CPU against its policy (minimum, maximum, target) and the last decision. Read-only.
  • Domains: hostnames with certificate status and any failure reason. . adds or removes one.
  • Blueprint: an environment’s services, databases and external hosts with their runtime state, the links between them, warnings, and what applying the applied revision again would change. Blueprint is generally available, requires the host.blueprint feature, and is read-only here.
  • Incidents: from Home’s . menu, the incidents of your whole team, each opening its environment’s list. Inside an environment, its incidents, newest first, with the highlighted one’s timeline. . marks one as mitigating, resolves or dismisses it; each restates the severity and the state change and asks for the incident’s short id.
  • Backups: an environment’s backups with kind, status, age, duration and size. . takes a backup now, or restores the highlighted successful one: the dialog says what is replaced (database and variables), that a safety snapshot is taken first and the previous database is kept for 7 days, and asks you to type the environment’s slug.
  • Notifications: yours, unread first and marked; . marks one or all as read.
  • Activity and Costs: the team’s activity feed, and its spend and over-budget scopes exactly as the API reports them (nothing is computed in the panel). Both are in the . menu on Home and Projects and use the team of the project you are in, else your first project’s team.
  • Compute jobs: the team’s compute jobs with the steps of the highlighted one; . cancels an active job (type the start of its id).
  • Recommendations: an environment’s operational recommendations (right-sizing and similar). . applies or dismisses an open one and reverts an applied one.
  • Groves (Canopy staff only; absent from the published CLI): Grove health, workloads and heartbeat; . drains or re-opens a Grove after you type its name.
  • Logs: the environment’s runtime logs. They follow live; p pauses, k and the arrow keys scroll back, G returns to the end, and f shows only the lines containing some text.
Key Action
↑ ↓ or k j Move. PgUp PgDn page, g G first and last
Enter or l Open
Esc or h Back. ] goes forward again
/ Go to a place by name. Tab completes, Enter goes, Esc closes
. Actions for this view
b, L From an environment: its builds, its runtime logs
t On a build: switch between its log, pipeline and platform activity
f, p Filter a list or the logs; pause or resume the log
s On the logs: cycle through everything, each service and each process
r Refresh
? Help
q Quit

The bar at the bottom shows the keys that fit your terminal. The panel is designed for 80 columns by 24 rows and needs at least 60 by 16. At 110 columns or more, Projects, Builds and Releases show a detail pane beside the list: the highlighted project’s environments, the highlighted build with its log, the highlighted release in full.

/ also runs a few read-only commands and shows their text in a scrollable pane, the same text the command prints: /projects-list, /deploys-list, /app-services-list, /incidents-list (these use the environment you are in) and /builds-show <build>. Space pages, g and G jump to the ends, Esc closes it.

/ accepts the names of places and the names of things in them:

/projects
/project corporate
/env staging
/build 452
/logs

Inside an environment, /build 452 finds the build by number. Text that is not a place name searches the project list. /recent lists places you opened lately. /profile shows the profile in use and the others, and /profile <name> switches to another one without leaving the panel (it reopens as that profile, at that profile’s last place).

/set glyphs auto|ascii|unicode and /set layout auto|single|split change how the panel draws and are remembered per installation. /set alone lists them.

Nothing is collected unless CANOPY_CLI_ANALYTICS_ENVIRONMENT_ID is set, the same opt-in as command usage; CANOPY_CLI_ANALYTICS_DISABLED=1 and DO_NOT_TRACK=1 always win. When it is set, closing the panel sends one event with how long it was open, how many views were opened, which kinds of view (never an id, a name or anything you typed), and how many profile switches and shell hand-offs there were.

The panel remembers the last place and recent places for each profile in control.json next to the CLI’s config.json, readable only by you. When it reopens at a place that no longer exists, it shows the nearest parent and says what is gone.

If the API rejects the session’s credentials, the panel says so instead of showing stale data. Press q, run canopy login, and open it again.

. lists what you can do in the current view. Deploy and redeploy ask for Enter before they run. Scaling asks for a process and a replica count. Opening a shell asks for a process (default web) and a command, leaves the panel for the interactive session, and returns to the same place when it ends. Setting a variable asks for the name, whether it is secret and the value, which is masked as you type for a secret. Deleting a variable or removing a domain asks you to type its name. Rolling back to a release asks you to type the environment’s name, and tells the server which release you saw as current, so the rollback is refused if someone else changed it in the meantime. The server’s refusal is shown as it is and the dialog stays open. Nothing runs without the confirmation, and Esc cancels.

Mutating commands are not run from /; they use the actions in ., each with its confirmation.