cargo-shuttle(1)

📦 version 0.57.3, in arch rolling

🎀 NAME — cargo-shuttle(1) (General Commands Manual) 🎀

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

📜 SYNOPSIS 📜

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

📝 DESCRIPTION 📝

Bestie, this is the CLI for the Shuttle platform (https://www.shuttle.dev/) — yes, that Shuttle. 💅

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

🌍 GLOBAL 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: .] — the working directory, defaulting to .
  • --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

🌟 NAME — init 🌟

init — Generate a Shuttle project from a template

📜 SYNOPSIS — init 📜

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

📝 DESCRIPTION — init 📝

Generate a Shuttle project from a template

✨ OPTIONS — init ✨

  • -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

🔐 LOGIN OPTIONS 🔐

  • --prompt — Prompt to paste the API key instead of opening the browser
  • --api-key <API_KEY> — Log in with this Shuttle API key

🌈 NAME — run 🌈

run — Run a project locally

📜 SYNOPSIS — run 📜

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

📝 DESCRIPTION — run 📝

Run a project locally

✨ OPTIONS — run ✨

  • -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

🦋 NAME — build 🦋

build — Build a project

📜 SYNOPSIS — build 📜

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

📝 DESCRIPTION — build 📝

Build a project

✨ OPTIONS — build ✨

  • --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

🚀 NAME — deploy 🚀

deploy — Deploy a project

📜 SYNOPSIS — deploy 📜

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

📝 DESCRIPTION — deploy 📝

Deploy a project

✨ OPTIONS — deploy ✨

  • --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

🧚 NAME — deployment 🧚

deployment — Manage deployments

📜 SYNOPSIS — deployment 📜

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

📝 DESCRIPTION — deployment 📝

Manage deployments

✨ OPTIONS — deployment ✨

  • -h, --help — Print help

🧭 SUBCOMMANDS — deployment 🧭

  • 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)

🎀 NAME — deployment list 🎀

list — List the deployments for a service

📜 SYNOPSIS — deployment list 📜

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

📝 DESCRIPTION — deployment list 📝

List the deployments for a service

✨ OPTIONS — deployment list ✨

  • --page <PAGE> [default: 1] — Which page to display
  • --limit <LIMIT> [default: 10] — How many deployments per page to display
  • -h, --help — Print help

📊 TABLE OPTIONS — deployment list 📊

  • --raw — Output tables without borders

💜 NAME — deployment status 💜

status — View status of a deployment

📜 SYNOPSIS — deployment status 📜

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

📝 DESCRIPTION — deployment status 📝

View status of a deployment

✨ OPTIONS — deployment status ✨

  • -h, --help — Print help
  • [DEPLOYMENT_ID] — ID of deployment to get status for

🔁 NAME — deployment redeploy 🔁

redeploy — Redeploy a previous deployment (if possible)

📜 SYNOPSIS — deployment redeploy 📜

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

📝 DESCRIPTION — deployment redeploy 📝

Redeploy a previous deployment (if possible)

✨ OPTIONS — deployment redeploy ✨

  • --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

🛑 NAME — deployment stop 🛑

stop — Stop running deployment(s)

📜 SYNOPSIS — deployment stop 📜

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

📝 DESCRIPTION — deployment stop 📝

Stop running deployment(s)

✨ OPTIONS — deployment stop ✨

  • --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

📜 NAME — logs 📜

logs — View build and deployment logs

📜 SYNOPSIS — logs 📜

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

📝 DESCRIPTION — logs 📝

View build and deployment logs

✨ OPTIONS — logs ✨

  • -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

🗂️ NAME — project 🗂️

project — Manage Shuttle projects

📜 SYNOPSIS — project 📜

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

📝 DESCRIPTION — project 📝

Manage Shuttle projects

✨ OPTIONS — project ✨

  • -h, --help — Print help

🧭 SUBCOMMANDS — project 🧭

  • 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)

✨ NAME — project create ✨

create — Create a project on Shuttle

📜 SYNOPSIS — project create 📜

create [-h|--help]

📝 DESCRIPTION — project create 📝

Create a project on Shuttle

✨ OPTIONS — project create ✨

  • -h, --help — Print help

🛠️ NAME — project update 🛠️

update — Update project config

📜 SYNOPSIS — project update 📜

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

📝 DESCRIPTION — project update 📝

Update project config

✨ OPTIONS — project update ✨

  • -h, --help — Print help

📡 NAME — project status 📡

status — Get the status of this project on Shuttle

📜 SYNOPSIS — project status 📜

status [-h|--help]

📝 DESCRIPTION — project status 📝

Get the status of this project on Shuttle

✨ OPTIONS — project status ✨

  • -h, --help — Print help

📋 NAME — project list 📋

list — List all projects you have access to

📜 SYNOPSIS — project list 📜

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

📝 DESCRIPTION — project list 📝

List all projects you have access to

✨ OPTIONS — project list ✨

  • -h, --help — Print help

📊 TABLE OPTIONS — project list 📊

  • --raw — Output tables without borders

🗑️ NAME — project delete 🗑️

delete — Delete a project and all linked data

📜 SYNOPSIS — project delete 📜

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

📝 DESCRIPTION — project delete 📝

Delete a project and all linked data

✨ OPTIONS — project delete ✨

  • -y, --yes — Skip confirmations and proceed
  • -h, --help — Print help

link — Link this workspace to a Shuttle project

link [-h|--help]

Link this workspace to a Shuttle project

  • -h, --help — Print help

🧃 NAME — resource 🧃

resource — Manage resources

📜 SYNOPSIS — resource 📜

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

💖 DESCRIPTION 💖

okay so <pink>this command's entire personality</pink> is manage resources. that's the job. that's the whole assignment. 🧚

(She's the hub, not the worker — she points you at the subcommands below and lets them do the actual lifting. main character energy, honestly. 👑)

✨ OPTIONS ✨

  • -h, --help — print help. the tried and true, the blueprint, the moment. 💅

🦋 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)

🎀 NAME 🎀

list — list the resources for a project

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

lists the resources for a project. that's it, she's simple, she's iconic, she ate. ✨

✨ OPTIONS ✨

  • --show-secrets — show secrets from resources (e.g. a password in a connection string). 👀 yes, actually shows the secret. this is the "do not screenshot, do not screen-share" option bestie — handle with care. 🙈
  • -h, --help — print help

🖤 TABLE OPTIONS 🖤

  • --raw — output tables without borders. minimalism era. no boxes, no lines, just data, unbothered, thriving. 🍓

🎀 NAME 🎀

delete — delete a resource

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

deletes a resource. gone. poof. 🫧

✨ OPTIONS ✨

  • -y, --yes — skip confirmations and proceed. she does not ask twice, she does not hesitate, she sends it. ⚡
  • -h, --help — print help
  • &lt;RESOURCE_TYPE&gt; — the type of the resource you're deleting. grab the exact string from the 'Type' column as shown in the resource list command — for example 'database::shared::postgres'. copy it, don't freestyle it. 📎

🎀 NAME 🎀

dump — dump a resource

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

dumps a resource. 💫

✨ OPTIONS ✨

  • -h, --help — print help
  • &lt;RESOURCE_TYPE&gt; — the type of the resource you're dumping. same drill as always: use the string from the 'Type' column in the resource list command, e.g. 'database::shared::postgres'. 🎯

🎀 NAME 🎀

certificate — manage SSL certificates for custom domains

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

manages SSL certificates for custom domains. 🔐 locked down, secured, slay.

✨ 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)

🎀 NAME 🎀

add — add an SSL certificate for a custom domain

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

adds an SSL certificate for a custom domain. new cert, new you. 🌈

✨ OPTIONS ✨

  • -h, --help — print help
  • &lt;DOMAIN&gt; — domain name. that's the one. 🌐

🎀 NAME 🎀

list — list the certificates for a project

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

lists the certificates for a project. all your certs, lined up, looking cute. 💌

✨ OPTIONS ✨

  • -h, --help — print help

🖤 TABLE OPTIONS 🖤

  • --raw — output tables without borders. again: minimalism, no borders, just vibes and values. 🍓

🎀 NAME 🎀

delete — delete an SSL certificate

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

deletes an SSL certificate. bye bestie, it was real. 👋

✨ OPTIONS ✨

  • -y, --yes — skip confirmations and proceed. no little "are you sure?" pop-up, just straight to it. ⚡
  • -h, --help — print help
  • &lt;DOMAIN&gt; — domain name

🎀 NAME 🎀

account — show info about your Shuttle account

🌸 SYNOPSIS 🌸

account [-h|--help]

💜 DESCRIPTION 💜

shows info about your Shuttle account. it's giving "who am i, really". 🪞

✨ OPTIONS ✨

  • -h, --help — print help

🎀 NAME 🎀

login — log in to the Shuttle platform

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

logs in to the Shuttle platform. come on in, the water's fine. 🛁

✨ OPTIONS ✨

  • -h, --help — print help

🔑 LOGIN OPTIONS 🔑

  • --prompt — prompt you to paste the API key instead of opening the browser. for when you want the keyboard moment, not the tab moment. ⌨️
  • --api-key <API_KEY> — log in with this Shuttle API key. hand it over directly. 🗝️

🎀 NAME 🎀

logout — log out of the Shuttle platform

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

logs out of the Shuttle platform. closing the tab on this chapter. 🚪

✨ OPTIONS ✨

  • --reset-api-key — reset the API key before logging out. clean slate, fresh start, new era. 🧼
  • -h, --help — print help

🎀 NAME 🎀

generate — generate shell completions and man page

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

generates shell completions and man page. maker of helpful little artifacts. 🛠️✨

✨ 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)

🎀 NAME 🎀

shell — generate shell completions

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

generates shell completions. tab-complete your way through life. 🐚💫

✨ OPTIONS ✨

  • -o, --output-file <OUTPUT_FILE> — output to a file (stdout by default). got somewhere specific to put it? say the word. 📁
  • -h, --help — print help
  • &lt;SHELL&gt; — the shell you want completions for

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

🎀 NAME 🎀

manpage — generate man page to the standard output

🌸 SYNOPSIS 🌸

manpage [-h|--help]

💜 DESCRIPTION 💜

generates the man page to the standard output. yes, the very thing you're reading. meta. 🤯

✨ OPTIONS ✨

  • -h, --help — print help

🎀 NAME 🎀

feedback — open an issue on GitHub and provide feedback

🌸 SYNOPSIS 🌸

feedback [-h|--help]

💜 DESCRIPTION 💜

opens an issue on GitHub and provides feedback. tell them how you really feel, respectfully. 💬🫶

✨ OPTIONS ✨

  • -h, --help — print help

🎀 NAME 🎀

upgrade — upgrade the Shuttle CLI binary

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

upgrades the Shuttle CLI binary. glow-up time. 🔥

✨ OPTIONS ✨

  • --preview — install an unreleased version from the repository's main branch. unreleased — you're getting the sneak peek, bestie, act accordingly. 👀
  • -h, --help — print help

🎀 NAME 🎀

mcp — commands for the Shuttle MCP server

🌸 SYNOPSIS 🌸

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

💜 DESCRIPTION 💜

holds the 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)

🎀 NAME 🎀

start — start the Shuttle MCP server

🌸 SYNOPSIS 🌸

start [-h|--help]

💜 DESCRIPTION 💜

starts the Shuttle MCP server. ignition. 🔥🤖

✨ OPTIONS ✨

  • -h, --help — print help

and that's the whole page, bestie, you made it to the end 🎉💖 you just read cargo-shuttle version 0.57.3 — the cargo-shuttle(1) page, no less. go forth, manage those resources, and remember: --raw is a lifestyle. mwah 🫶💅

📦 where this page comes from