Getting Started
Command Line Interface


Interaction with the Shuttle services is through the Command Line Interface (CLI). A combination of commands, and sub-commands, each with options, allow a variety of management tasks to be performed.

Any given command is issued in the format: cargo shuttle [OPTIONS] <COMMAND>

To get an overview of available commands and any available options, run:

cargo shuttle help


Tip: Options are entered in the format: --name, as an example.

Options can be passed in with commands to customize a command’s, or a sub-command’s, behaviour.


Tip: Run a command with the --help flag to see available subcommands

The Shuttle commands are:

initCreate a new Shuttle project
runRun a Shuttle service locally
deployDeploy a Shuttle service
deploymentManage deployments of a Shuttle service
statusView the status of a Shuttle service
stopStop this Shuttle service
logsView the logs of a deployment in this Shuttle service
projectList or manage projects on Shuttle
resourceManage resources of a Shuttle project
secretsManage secrets for this Shuttle service
cleanRemove cargo build artifacts in the Shuttle environment
loginLogin to the Shuttle platform
logoutLog out of the Shuttle platform
generateGenerate shell completions
feedbackOpen an issue on GitHub and provide feedback
helpPrint this message or the help of the given subcommand(s)


Several commands have sub-commands which allow more fine grained management tasks. For example, the project command has the following sub-commands:

startCreate an environment for this project on Shuttle
statusCheck the status of this project’s environment on Shuttle
stopDestroy this project’s environment (container) on Shuttle
restartDestroy and create an environment for this project on Shuttle
listList all projects belonging to the calling account

Sub-commands may also have options which can be set if desired.