Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cookbook to CLI docs #126

Merged
merged 1 commit into from
Jun 9, 2023
Merged

Add cookbook to CLI docs #126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions introduction/shuttle-commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,14 @@ For example, the `project` command has the following sub-commands:
| list | List all projects belonging to the calling account |

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

# Cookbook

These are some useful commands that are handy to keep in your back pocket:

- `cargo shuttle run`: Run the project locally so you can test your changes.
- `cargo shuttle project start`: Initialize an environment for this project on shuttle.
- `cargo shuttle deploy`: Deploy the current state of the project to the public internet though shuttle.
- `cargo shuttle deploy --allow-dirty`: Deploy the project to shuttle (including files not committed to git).
- `cargo shuttle deployment`: Either list existing deployments or get the status of a particular deployment.
- `cargo shuttle logs --follow`: Fetch the logs of the deployed service and stream them to your terminal.