cargo-shuttle(1) General Commands Manual cargo-shuttle(1)

cargo-shuttle - CLI for the Shuttle platform (https://www.shuttle.dev/)

cargo-shuttle [--offline] [--debug] [--output] [--working-directory] [--name] [--id] [-h|--help] [-V|--version] [dummy] <subcommands>

CLI for the Shuttle platform (https://www.shuttle.dev/)

See the CLI docs for more information: https://docs.shuttle.dev/guides/cli

Print help (see a summary with '-h')
Print version

Disable network requests that are not strictly necessary. Limits some features
May also be specified with the SHUTTLE_OFFLINE environment variable.
Turn on tracing output for Shuttle libraries. (WARNING: can print sensitive data)
May also be specified with the SHUTTLE_DEBUG environment variable.
What format to print output in

[possible values: normal, json]

May also be specified with the SHUTTLE_OUTPUT_MODE environment variable.
The name of the project to target or create
The id of the project to target

Generate a Shuttle project from a template
Run a project locally
Deploy a project
Manage deployments
View build and deployment logs
Manage Shuttle projects
Manage resources
Manage SSL certificates for custom domains
Show info about your Shuttle account
Log in to the Shuttle platform
Log out of the Shuttle platform
Generate shell completions and man page
Open an issue on GitHub and provide feedback
Upgrade the Shuttle CLI binary
Commands for the Shuttle MCP server
Print this message or the help of the given subcommand(s)

v0.57.3

init - Generate a Shuttle project from a template

init [-t|--template] [--from] [--subfolder] [--force-name] [--create-project] [--no-git] [--prompt] [--api-key] [-h|--help] [PATH]

Generate a Shuttle project from a template

Clone a starter template from Shuttle's official examples

Possible values:

  • axum: Axum - Modular web framework from the Tokio ecosystem
  • actix-web: Actix Web - Powerful and fast web framework
  • rocket: Rocket - Simple and easy-to-use web framework
  • loco: Loco - Batteries included web framework based on Axum
  • salvo: Salvo - Powerful and simple web framework
  • poem: Poem - Full-featured and easy-to-use web framework
  • poise: Poise - Discord Bot framework with good slash command support
  • rama: Rama - Modular service framework to build proxies, servers and clients
  • serenity: Serenity - Discord Bot framework
  • tower: Tower - Modular service library
  • warp: Warp - Web framework
  • none: No template - Make a custom service
Clone a template from a git repository or local path
Path to the template in the source (used with --from)
Don't check the project name's validity or availability and use it anyways
Whether to create a project on Shuttle
Don't initialize a new git repository
Print help (see a summary with '-h')
[PATH] [default: .]
Path where to place the new Shuttle project

LOGIN OPTIONS

Prompt to paste the API key instead of opening the browser
Log in with this Shuttle API key

run - Run a project locally

run [-p|--port] [--external] [--raw] [--secrets] [-r|--release] [--bacon] [-h|--help]

Run a project locally

Port to start service on
May also be specified with the PORT environment variable.
Use 0.0.0.0 instead of localhost (for usage with local external devices)
Don't display timestamps and log origin tags
Use this secrets file instead
Use release mode for building the project
Uses bacon crate to build/run the project in watch mode
Print help

build - Build a project

build [--output-archive] [-r|--release] [--bacon] [-h|--help]

Build a project

Output the build archive to a file instead of building
Use release mode for building the project
Uses bacon crate to build/run the project in watch mode
Print help

deploy - Deploy a project

deploy [--allow-dirty] [--output-archive] [--no-follow] [--raw] [--secrets] [-h|--help]

Deploy a project

Allow deployment with uncommitted files
Output the deployment archive to a file instead of sending a deployment request
Don't follow the deployment status, exit after the operation begins
Don't display timestamps and log origin tags
Use this secrets file instead
Print help

deployment - Manage deployments

deployment [-h|--help] <subcommands>

Manage deployments

Print help

List the deployments for a service
View status of a deployment
Redeploy a previous deployment (if possible)
Stop running deployment(s)
Print this message or the help of the given subcommand(s)

list - List the deployments for a service

list [--page] [--limit] [--raw] [-h|--help]

List the deployments for a service

Which page to display
How many deployments per page to display
Print help

TABLE OPTIONS

Output tables without borders

status - View status of a deployment

status [-h|--help] [DEPLOYMENT_ID]

View status of a deployment

Print help
[DEPLOYMENT_ID]
ID of deployment to get status for

redeploy - Redeploy a previous deployment (if possible)

redeploy [--no-follow] [--raw] [-h|--help] [DEPLOYMENT_ID]

Redeploy a previous deployment (if possible)

Don't follow the deployment status, exit after the operation begins
Don't display timestamps and log origin tags
Print help
[DEPLOYMENT_ID]
ID of deployment to redeploy

stop - Stop running deployment(s)

stop [--no-follow] [--raw] [-h|--help]

Stop running deployment(s)

Don't follow the deployment status, exit after the operation begins
Don't display timestamps and log origin tags
Print help

logs - View build and deployment logs

logs [-l|--latest] [--raw] [-h|--help] [DEPLOYMENT_ID]

View build and deployment logs

View logs from the most recent deployment (which is not always the running one)
Don't display timestamps and log origin tags
Print help
[DEPLOYMENT_ID]
Deployment ID to get logs for. Defaults to the current deployment

project - Manage Shuttle projects

project [-h|--help] <subcommands>

Manage Shuttle projects

Print help

Create a project on Shuttle
Update project config
Get the status of this project on Shuttle
List all projects you have access to
Delete a project and all linked data
Link this workspace to a Shuttle project
Print this message or the help of the given subcommand(s)

create - Create a project on Shuttle

create [-h|--help]

Create a project on Shuttle

Print help

update - Update project config

update [-h|--help] <subcommands>

Update project config

Print help

status - Get the status of this project on Shuttle

status [-h|--help]

Get the status of this project on Shuttle

Print help

list - List all projects you have access to

list [--raw] [-h|--help]

List all projects you have access to

Print help

TABLE OPTIONS

Output tables without borders

delete - Delete a project and all linked data

delete [-y|--yes] [-h|--help]

Delete a project and all linked data

Skip confirmations and proceed
Print help

link - Link this workspace to a Shuttle project

link [-h|--help]

Link this workspace to a Shuttle project

Print help

resource - Manage resources

resource [-h|--help] <subcommands>

Manage resources

Print help

List the resources for a project
Delete a resource
Print this message or the help of the given subcommand(s)

list - List the resources for a project

list [--show-secrets] [--raw] [-h|--help]

List the resources for a project

Show secrets from resources (e.g. a password in a connection string)
Print help

TABLE OPTIONS

Output tables without borders

delete - Delete a resource

delete [-y|--yes] [-h|--help] <RESOURCE_TYPE>

Delete a resource

Skip confirmations and proceed
Print help
<RESOURCE_TYPE>
Type of the resource to delete. Use the string in the 'Type' column as displayed in the `resource list` command. For example, 'database::shared::postgres'

dump - Dump a resource

dump [-h|--help] <RESOURCE_TYPE>

Dump a resource

Print help
<RESOURCE_TYPE>
Type of the resource to dump. Use the string in the 'Type' column as displayed in the `resource list` command. For example, 'database::shared::postgres'

certificate - Manage SSL certificates for custom domains

certificate [-h|--help] <subcommands>

Manage SSL certificates for custom domains

Print help

Add an SSL certificate for a custom domain
List the certificates for a project
Delete an SSL certificate
Print this message or the help of the given subcommand(s)

add - Add an SSL certificate for a custom domain

add [-h|--help] <DOMAIN>

Add an SSL certificate for a custom domain

Print help
<DOMAIN>
Domain name

list - List the certificates for a project

list [--raw] [-h|--help]

List the certificates for a project

Print help

TABLE OPTIONS

Output tables without borders

delete - Delete an SSL certificate

delete [-y|--yes] [-h|--help] <DOMAIN>

Delete an SSL certificate

Skip confirmations and proceed
Print help
<DOMAIN>
Domain name

account - Show info about your Shuttle account

account [-h|--help]

Show info about your Shuttle account

Print help

login - Log in to the Shuttle platform

login [--prompt] [--api-key] [-h|--help]

Log in to the Shuttle platform

Print help

LOGIN OPTIONS

Prompt to paste the API key instead of opening the browser
Log in with this Shuttle API key

logout - Log out of the Shuttle platform

logout [--reset-api-key] [-h|--help]

Log out of the Shuttle platform

Reset the API key before logging out
Print help

generate - Generate shell completions and man page

generate [-h|--help] <subcommands>

Generate shell completions and man page

Print help

Generate shell completions
Generate man page to the standard output
Print this message or the help of the given subcommand(s)

shell - Generate shell completions

shell [-o|--output-file] [-h|--help] <SHELL>

Generate shell completions

Output to a file (stdout by default)
Print help
<SHELL>
The shell to generate shell completion for

[possible values: bash, elvish, fish, powershell, zsh]

manpage - Generate man page to the standard output

manpage [-h|--help]

Generate man page to the standard output

Print help

feedback - Open an issue on GitHub and provide feedback

feedback [-h|--help]

Open an issue on GitHub and provide feedback

Print help

upgrade - Upgrade the Shuttle CLI binary

upgrade [--preview] [-h|--help]

Upgrade the Shuttle CLI binary

Install an unreleased version from the repository's main branch
Print help

mcp - Commands for the Shuttle MCP server

mcp [-h|--help] <subcommands>

Commands for the Shuttle MCP server

Print help

Start the Shuttle MCP server
Print this message or the help of the given subcommand(s)

start - Start the Shuttle MCP server

start [-h|--help]

Start the Shuttle MCP server

Print help
cargo-shuttle 0.57.3