Meta tags:
description= Run actions on your Upsun projects, select environments, execute remote commands, automate repetitive tasks, and enable tab autocompletion for the CLI.;
Headings (most frequently used words):
the, cli, commands, on, and, use, upsun, documentation, index, this, page, select, right, project, environment, choose, between, git, run, your, container, customize, autocomplete, getting, started, reference, rootnotfoundexception, automate, repetitive, tasks,
Text of the page (most frequently used words):
the (40), #project (29), upsun (26), cli (24), #environment (17), your (15), and (14), commands (14), run (12), for (10), use (10), command (10), this (9), page (8), you (7), directory (7), get (7), documentation (6), projects (6), all (5), export (5), automate (5), tasks (5), remote (5), git (5), developer (4), reference (4), api (4), home (4), app (4), example (4), repetitive (4), file (4), with (4), from (4), select (4), copy (4), github (3), following (3), autocompletion (3), local (3), locally (3), customize (3), ssh (3), script (3), specific (3), arguments (3), container (3), can (3), between (3), not (3), list (3), rootnotfoundexception (3), inside (3), clone (3), help (3), getting (3), started (3), using (2), assistant (2), linkedin (2), youtube (2), blog (2), tutorials (2), docs (2), tokens (2), install (2), completion (2), shell (2), follow (2), homebrew (2), tab (2), options (2), enable (2), autocomplete (2), myapp (2), mount (2), upsun_cli_no_interaction (2), main (2), platform_branch (2), platform_project (2), prompts (2), set (2), variables (2), cache (2), rebuild (2), drush (2), feature (2), python (2), only (2), code (2), environments (2), don (2), activate (2), before (2), working (2), push (2), complete (2), choose (2), console (2), project_id (2), error (2), directly (2), that (2), info (2), staging (2), right (2), identity (2), host (2), depth (2), available (2), search (2), free (2), trial (2), index (2), responses, are, generated, may, contain, mistakes, built, hosted, mintlify, platform, powered, careers, pricing, about, company, support, community, changelog, resources, yes, was, helpful, last, modified, june, 2026, eval, add, startup, equivalent, zshrc, bashrc, manually, provides, some, values, valid, regions, these, steps, backup, target, download, sync, points, scripts, like, syncing, files, bypass, confirmation, behavior, configuration, details, see, customization, instructions, config, yaml, named, current, against, any, added, hook, dependencies, merges, codebase, affected, need, checked, out, merge, require, configured, sufficient, namespace, overlap, but, offer, more, supports, pushing, continue, without, waiting, wait, replace, find, accessible, means, cannot, determine, fix, root, found, instead, might, able, identify, running, produce, also, applies, selecting, variable, platform_application_name, multi, specify, either, two, ways, checkout, detects, automatically, requires, empty, unassociated, them, title, defaults, build, usage, description, aliases, output, similar, lets, manage, terminal, actions, execute, coding, agents, initialize, navigation, watch, demo, ask, skip, content, discover, pages, exploring, further, fetch, llms, txt,
Text of the page (random words):
use the upsun cli upsun developer documentation index fetch the complete documentation index at llms txt use this file to discover all available pages before exploring further skip to main content upsun developer home page search k ask assistant i console watch a demo free trial free trial search navigation getting started use the upsun cli home docs tutorials ai api cli blog cli home getting started install use api tokens initialize a project reference command reference ai coding agents on this page select the right project and environment rootnotfoundexception choose between the cli and git commands run commands on your container customize the cli automate repetitive tasks autocomplete commands getting started use the upsun cli copy page copy page run actions on your upsun projects select environments execute remote commands automate repetitive tasks and enable tab autocompletion for the cli copy page copy page the upsun cli lets you manage projects run remote commands and automate tasks directly from your terminal list all available commands upsun list to get help on a specific command use help upsun help get you get output similar to the following command project get aliases get description clone a project locally usage upsun get e environment environment depth depth build p project project host host i identity file identity file project directory arguments project the project id directory the directory to clone to defaults to the project title select the right project and environment if you run a command that requires a specific project and environment from an empty or unassociated directory the cli prompts you to select them if your working directory is inside a local checkout of your project the cli detects your project and environment automatically specify the project and environment in either of two ways as arguments for the command upsun environment info project my project environment staging with environment variables export platform_project my project export platform_branch staging upsun environment info in multi app projects this also applies to selecting the app use the platform_application_name environment variable rootnotfoundexception if you clone a project with git directly instead of upsun get the cli might not be able to identify the project running a cli command from inside that directory can produce this error rootnotfoundexception project root not found this can only be run from inside a project directory this error means the cli cannot determine the project to fix it run upsun project set remote project project_id replace project_id with the id of your project find your project id in the console or run upsun projects to list all accessible projects choose between the cli and git commands cli commands in the environment namespace overlap with git commands but offer more options for example upsun push supports activate to activate an environment before pushing and no wait to continue working without waiting for the push to complete cli commands don t require a configured git remote a project id is sufficient for example upsun merge only merges code between remote environments your local codebase is not affected and you don t need the code checked out locally run commands on your container to run upsun cli commands against your container you can use any command added in dependencies or a hook upsun ssh command arguments for example to run a specific python script named my script py on your current environment run the following command upsun ssh python my script py or to use drush to rebuild the cache on the feature environment run this command upsun ssh e feature drush y cache rebuild customize the cli customize cli behavior using a configuration file upsun cli config yaml or environment variables for details see the customization instructions on github automate repetitive tasks use the cli in scripts to automate repetitive tasks like syncing files locally to bypass confirmation prompts set upsun_cli_no_interaction 1 for example to sync all mount points for your app myapp export platform_project my project export platform_branch main export upsun_cli_no_interaction 1 upsun mount download all app myapp target local backup autocomplete commands the cli provides tab autocompletion for commands options and some values your projects valid regions to enable autocompletion follow these steps homebrew manually follow the homebrew documentation on shell completion add the following to your shell s startup bashrc zshrc or the equivalent eval upsun completion last modified on june 11 2026 was this page helpful yes no install api tokens upsun developer home page github youtube x linkedin docs documentation tutorials api reference cli reference resources changelog upsun blog community support company about pricing careers github youtube x linkedin powered by this documentation is built and hosted on mintlify a developer documentation platform assistant responses are generated using ai and may contain mistakes
|
