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

cargo-shuttle - A cargo command for the Shuttle platform (https://www.shuttle.rs/)

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

A cargo command for the Shuttle platform (https://www.shuttle.rs/)

See the CLI docs (https://docs.shuttle.rs/getting-started/shuttle-commands) for more information.

Specify the working directory
Specify the name of the project (overrides crate name)
Run this command against the API at the supplied URL (allows targeting a custom deployed instance for this command only, mainly for development)
May also be specified with the SHUTTLE_API environment variable.
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 cargo-shuttle and shuttle libraries
May also be specified with the SHUTTLE_DEBUG environment variable.
Print help (see a summary with '-h')
Print version

Create a new Shuttle project
Run a Shuttle service locally
Deploy a Shuttle service
Manage deployments of a Shuttle service
View the status of a Shuttle service
Stop this Shuttle service
View the logs of a deployment in this Shuttle service
List or manage projects on Shuttle
Manage resources of a Shuttle project
Remove cargo build artifacts in the Shuttle environment
Login to the Shuttle platform
Log out of the Shuttle platform
Generate shell completions and man page
Open an issue on GitHub and provide feedback
Print this message or the help of the given subcommand(s)

v0.44.0

init - Create a new Shuttle project

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

Create a new Shuttle project

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
  • serenity: Serenity - Discord Bot framework
  • tower: Tower - Modular service library
  • thruster: Thruster - Web framework
  • tide: Tide - Web framework
  • warp: Warp - Web framework
  • none: No template - Make a custom service
Clone a template from a git repository or local path using cargo-generate
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 start the container for this project on Shuttle, and claim the project name
Don't initialize a new git repository
API key for the Shuttle platform
Print help (see a summary with '-h')
[PATH] [default: .]
Path where to place the new Shuttle project

run - Run a Shuttle service locally

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

Run a Shuttle service 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)
Use release mode for building the project
Don't display timestamps and log origin tags
Use this secrets file instead
Print help

deploy - Deploy a Shuttle service

deploy [--allow-dirty] [--no-test] [--raw] [--secrets] [-h|--help]

Deploy a Shuttle service

Allow deployment with uncommitted files
Don't run pre-deploy tests
Don't display timestamps and log origin tags
Use this secrets file instead
Print help

deployment - Manage deployments of a Shuttle service

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

Manage deployments of a Shuttle service

Print help

List all the deployments for a service
View status of a deployment
Print this message or the help of the given subcommand(s)

list - List all the deployments for a service

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

List all the deployments for a service

Which page to display
How many projects per page to display
Output table in `raw` format
Print help

status - View status of a deployment

status [-h|--help] <ID>

View status of a deployment

Print help
<ID>
ID of deployment to get status for

status - View the status of a Shuttle service

status [-h|--help]

View the status of a Shuttle service

Print help

stop - Stop this Shuttle service

stop [-h|--help]

Stop this Shuttle service

Print help

logs - View the logs of a deployment in this Shuttle service

logs [-l|--latest] [-f|--follow] [--raw] [--head] [--tail] [--all] [-h|--help] [ID]

View the logs of a deployment in this Shuttle service

View logs from the most recent deployment (which is not always the latest running one)
Follow log output
Don't display timestamps and log origin tags
View the first N log lines
View the last N log lines
View all log lines
Print help
[ID]
Deployment ID to get logs for. Defaults to currently running deployment

project - List or manage projects on Shuttle

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

List or manage projects on Shuttle

Print help

Create an environment for this project on Shuttle
Check the status of this project's environment on Shuttle
Destroy this project's environment (container) on Shuttle
Destroy and create an environment for this project on Shuttle
List all projects belonging to the calling account
Delete a project and all linked data
Print this message or the help of the given subcommand(s)

start - Create an environment for this project on Shuttle

start [--idle-minutes] [-h|--help]

Create an environment for this project on Shuttle

How long to wait before putting the project in an idle state due to inactivity. 0 means the project will never idle
Print help

status - Check the status of this project's environment on Shuttle

status [-f|--follow] [-h|--help]

Check the status of this project's environment on Shuttle

Follow status of project command
Print help

stop - Destroy this project's environment (container) on Shuttle

stop [-h|--help]

Destroy this project's environment (container) on Shuttle

Print help

restart - Destroy and create an environment for this project on Shuttle

restart [--idle-minutes] [-h|--help]

Destroy and create an environment for this project on Shuttle

How long to wait before putting the project in an idle state due to inactivity. 0 means the project will never idle
Print help

list - List all projects belonging to the calling account

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

List all projects belonging to the calling account

(deprecated) Which page to display
(deprecated) How many projects per page to display
Output table in `raw` format
Print help

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

resource - Manage resources of a Shuttle project

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

Manage resources of a Shuttle project

Print help

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

list - List all the resources for a project

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

List all the resources for a project

Output table in `raw` format
Show secrets from resources (e.g. a password in a connection string)
Print help

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'

clean - Remove cargo build artifacts in the Shuttle environment

clean [-h|--help]

Remove cargo build artifacts in the Shuttle environment

Print help

login - Login to the Shuttle platform

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

Login to the Shuttle platform

API key for the Shuttle platform
Print help

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] [-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
cargo-shuttle 0.44.0