cargo-shuttle(1)

Usage

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

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

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

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

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

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

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

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

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

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

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

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

create [{-h | --help}]

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

status [{-h | --help}]

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

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

link [{-h | --help}]

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

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

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

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

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

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

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

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

account [{-h | --help}]

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

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

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

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

manpage [{-h | --help}]

feedback [{-h | --help}]

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

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

start [{-h | --help}]

Overview

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

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

Options

-h, --help: Print help (see a summary with '-h')

-V, --version: Print version

Options

--offline: Disable network requests that are not strictly necessary. Limits some features

May also be specified with the SHUTTLE_OFFLINE environment variable.

--debug: Turn on tracing output for Shuttle libraries. (WARNING: can print sensitive data)

May also be specified with the SHUTTLE_DEBUG environment variable.

--output <OUTPUT_MODE> [default: normal]

What format to print output in

[possible values: normal, json]

May also be specified with the SHUTTLE_OUTPUT_MODE environment variable.

--working-directory <WORKING_DIRECTORY> [default: .]

--name <NAME>: The name of the project to target or create

--id <ID>: The id of the project to target

Subcommands

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

Version

v0.57.3

Overview

Generate a Shuttle project from a template

Options

-t, --template <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

--from <FROM>: Clone a template from a git repository or local path

--subfolder <SUBFOLDER>: Path to the template in the source (used with --from)

--force-name: Don't check the project name's validity or availability and use it anyways

--create-project: Whether to create a project on Shuttle

--no-git: Don't initialize a new git repository

-h, --help: Print help (see a summary with '-h')

[PATH] [default: .]: Path where to place the new Shuttle project

Options

--prompt: Prompt to paste the API key instead of opening the browser

--api-key <API_KEY>: Log in with this Shuttle API key

Overview

Run a project locally

Options

-p, --port <PORT> [default: 8000]: Port to start service on

May also be specified with the PORT environment variable.

--external: Use 0.0.0.0 instead of localhost (for usage with local external devices)

--raw: Don't display timestamps and log origin tags

--secrets <SECRETS>: Use this secrets file instead

-r, --release: Use release mode for building the project

--bacon: Uses bacon crate to build/run the project in watch mode

-h, --help: Print help

Overview

Build a project

Options

--output-archive <OUTPUT_ARCHIVE>: Output the build archive to a file instead of building

-r, --release: Use release mode for building the project

--bacon: Uses bacon crate to build/run the project in watch mode

-h, --help: Print help

Overview

Deploy a project

Options

--allow-dirty: Allow deployment with uncommitted files

--output-archive <OUTPUT_ARCHIVE>: Output the deployment archive to a file instead of sending a deployment request

--no-follow: Don't follow the deployment status, exit after the operation begins

--raw: Don't display timestamps and log origin tags

--secrets <SECRETS>: Use this secrets file instead

-h, --help: Print help

Overview

Manage deployments

Options

-h, --help: Print help

Subcommands

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

Overview

List the deployments for a service

Options

`--page <PAGE> [default: 1]`	Which page to display
`--limit <LIMIT> [default: 10]`	How many deployments per page to display

-h, --help: Print help

Options

--raw: Output tables without borders

Overview

View status of a deployment

Options

-h, --help: Print help

[DEPLOYMENT_ID]: ID of deployment to get status for

Overview

Redeploy a previous deployment (if possible)

Options

--no-follow: Don't follow the deployment status, exit after the operation begins

--raw: Don't display timestamps and log origin tags

-h, --help: Print help

[DEPLOYMENT_ID]: ID of deployment to redeploy

Overview

Stop running deployment(s)

Options

--no-follow: Don't follow the deployment status, exit after the operation begins

--raw: Don't display timestamps and log origin tags

-h, --help: Print help

Overview

View build and deployment logs

Options

-l, --latest: View logs from the most recent deployment (which is not always the running one)

--raw: Don't display timestamps and log origin tags

-h, --help: Print help

[DEPLOYMENT_ID]: Deployment ID to get logs for. Defaults to the current deployment

Overview

Manage Shuttle projects

Options

-h, --help: Print help

Subcommands

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

Overview

Create a project on Shuttle

Options

-h, --help: Print help

Overview

Update project config

Options

-h, --help: Print help

Overview

Get the status of this project on Shuttle

Options

-h, --help: Print help

Overview

List all projects you have access to

Options

-h, --help: Print help

Options

--raw: Output tables without borders

Overview

Delete a project and all linked data

Options

-y, --yes: Skip confirmations and proceed

-h, --help: Print help

Overview

Link this workspace to a Shuttle project

Options

-h, --help: Print help

Overview

Manage resources

Options

-h, --help: Print help

Subcommands

`resource-list(1)`	List the resources for a project
`resource-delete(1)`	Delete a resource
`resource-help(1)`	Print this message or the help of the given subcommand(s)

Overview

List the resources for a project

Options

--show-secrets: Show secrets from resources (e.g. a password in a connection string)

-h, --help: Print help

Options

--raw: Output tables without borders

Overview

Delete a resource

Options

-y, --yes: Skip confirmations and proceed

-h, --help: 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'

Overview

Dump a resource

Options

-h, --help: 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'

Overview

Manage SSL certificates for custom domains

Options

-h, --help: Print help

Subcommands

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

Overview

Add an SSL certificate for a custom domain

Options

-h, --help: Print help

<DOMAIN>: Domain name

Overview

List the certificates for a project

Options

-h, --help: Print help

Options

--raw: Output tables without borders

Overview

Delete an SSL certificate

Options

-y, --yes: Skip confirmations and proceed

-h, --help: Print help

<DOMAIN>: Domain name

Overview

Show info about your Shuttle account

Options

-h, --help: Print help

Overview

Log in to the Shuttle platform

Options

-h, --help: Print help

Options

--prompt: Prompt to paste the API key instead of opening the browser

--api-key <API_KEY>: Log in with this Shuttle API key

Overview

Log out of the Shuttle platform

Options

--reset-api-key: Reset the API key before logging out

-h, --help: Print help

Overview

Generate shell completions and man page

Options

-h, --help: Print help

Subcommands

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

Overview

Generate shell completions

Options

-o, --output-file <OUTPUT_FILE>: Output to a file (stdout by default)

-h, --help: Print help

<SHELL>

The shell to generate shell completion for

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

Overview

Generate man page to the standard output

Options

-h, --help: Print help

Overview

Open an issue on GitHub and provide feedback

Options

-h, --help: Print help

Overview

Upgrade the Shuttle CLI binary

Options

--preview: Install an unreleased version from the repository's main branch

-h, --help: Print help

Overview

Commands for the Shuttle MCP server

Options

-h, --help: Print help

Subcommands

`mcp-start(1)`	Start the Shuttle MCP server
`mcp-help(1)`	Print this message or the help of the given subcommand(s)

Overview

Start the Shuttle MCP server

Options

-h, --help: Print help