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.

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

docs: Update links and commands #948

Merged
merged 2 commits into from
May 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 11 additions & 11 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a href="https://circleci.com/gh/shuttle-hq/shuttle/">
<img alt="build status" src="https://circleci.com/gh/shuttle-hq/shuttle.svg?style=shield"/>
</a>
<a href="https://discord.gg/H33rRDTm3p">
<a href="https://discord.gg/shuttle">
<img alt="discord" src="https://img.shields.io/discord/803236282088161321?logo=discord"/>
</a>
</p>
Expand Down
60 changes: 31 additions & 29 deletions cargo-shuttle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a href="https://circleci.com/gh/shuttle-hq/shuttle/">
<img alt="build status" src="https://circleci.com/gh/shuttle-hq/shuttle.svg?style=shield"/>
</a>
<a href="https://discord.gg/H33rRDTm3p">
<a href="https://discord.gg/shuttle">
<img alt="discord" src="https://img.shields.io/discord/803236282088161321?logo=discord"/>
</a>
</p>
Expand Down Expand Up @@ -71,26 +71,28 @@ Run `cargo shuttle help` to see the basic usage:
Usage: cargo-shuttle [OPTIONS] <COMMAND>

Commands:
deploy deploy a shuttle service
deployment manage deployments of a shuttle service
init create a new shuttle service
generate generate shell completions
status view the status of a shuttle service
logs view the logs of a deployment in this shuttle service
clean remove artifacts that were generated by cargo
stop stop this shuttle service
secrets manage secrets for this shuttle service
login login to the shuttle platform
logout log out of the shuttle platform
run run a shuttle service locally
feedback Open an issue on github and provide feedback
project manage a project on shuttle
init Create a new shuttle project
run Run a shuttle service locally
deploy Deploy a shuttle service
deployment Manage deployments of a shuttle service
status View the status of a shuttle service
stop Stop this shuttle service
logs View the logs of a deployment in this shuttle service
project List or manage projects on shuttle
resource Manage resources of a shuttle project
secrets Manage secrets for this shuttle service
clean Remove cargo build artifacts in the shuttle environment
login Login to the shuttle platform
logout Log out of the shuttle platform
generate Generate shell completions
feedback Open an issue on GitHub and provide feedback
help Print this message or the help of the given subcommand(s)

Options:
--api-url <API_URL> run this command against the api at the supplied url (allows targeting a custom deployed instance for this command only) [env: SHUTTLE_API=]
--working-directory <WORKING_DIRECTORY> Specify the working directory [default: .]
--name <NAME> Specify the name of the project (overrides crate name)
--api-url <API_URL> Run this command against the API at the supplied URL (allows targeting a custom deployed instance for this command only, mainly
for development) [env: SHUTTLE_API=]
-h, --help Print help
-V, --version Print version
```
Expand All @@ -101,22 +103,22 @@ To initialize a shuttle project with boilerplates, run `cargo shuttle init [OPTI

Currently, `cargo shuttle init` supports the following frameworks:

- `--actix-web`: for [actix web](https://actix.rs/) framework
- `--axum`: for [axum](https://github.com/tokio-rs/axum) framework
- `--poem`: for [poem](https://github.com/poem-web/poem) framework
- `--poise`: for [poise](https://github.com/serenity-rs/poise) discord bot framework
- `--rocket`: for [rocket](https://rocket.rs/) framework
- `--salvo`: for [salvo](https://salvo.rs/) framework
- `--serenity`: for [serenity](https://github.com/serenity-rs/serenity) discord bot framework
- `--thruster`: for [thruster](https://github.com/thruster-rs/Thruster) framework
- `--tide`: for [tide](https://github.com/http-rs/tide) framework
- `--tower`: for [tower](https://github.com/tower-rs/tower) library
- `--warp`: for [warp](https://github.com/seanmonstar/warp) framework
- `--template actix-web`: for [actix web](https://actix.rs/) framework
- `--template axum`: for [axum](https://github.com/tokio-rs/axum) framework
- `--template poem`: for [poem](https://github.com/poem-web/poem) framework
- `--template poise`: for [poise](https://github.com/serenity-rs/poise) discord bot framework
- `--template rocket`: for [rocket](https://rocket.rs/) framework
- `--template salvo`: for [salvo](https://salvo.rs/) framework
- `--template serenity`: for [serenity](https://github.com/serenity-rs/serenity) discord bot framework
- `--template thruster`: for [thruster](https://github.com/thruster-rs/Thruster) framework
- `--template tide`: for [tide](https://github.com/http-rs/tide) framework
- `--template tower`: for [tower](https://github.com/tower-rs/tower) library
- `--template warp`: for [warp](https://github.com/seanmonstar/warp) framework

For example, running the following command will initialize a project for [rocket](https://rocket.rs/):

```sh
cargo shuttle init --rocket my-rocket-app
cargo shuttle init --template rocket my-rocket-app
```

This should generate the following dependency in `Cargo.toml`:
Expand Down Expand Up @@ -229,4 +231,4 @@ During our alpha period, API keys are completely free and you can deploy as many

Just keep in mind that there may be some kinks that require us to take all deployments down once in a while. In certain circumstances we may also have to delete all the data associated with those deployments.

To contribute to `cargo-shuttle` or stay updated with our development, please [open an issue, discussion or PR on Github](https://github.com/shuttle-hq/shuttle) and [join our Discord](https://discord.gg/H33rRDTm3p)! 🚀
To contribute to `cargo-shuttle` or stay updated with our development, please [open an issue, discussion or PR on Github](https://github.com/shuttle-hq/shuttle) and [join our Discord](https://discord.gg/shuttle)! 🚀
10 changes: 5 additions & 5 deletions cargo-shuttle/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -791,11 +791,6 @@ impl Shuttle {
}
}

println!(
"Run `cargo shuttle project start` to create a project environment on Shuttle.\n\
Run `cargo shuttle deploy` to deploy your Shuttle service."
);

// If prior signal received is set to true we must stop all the existing runtimes and
// exit the `local_run`.
if signal_received {
Expand Down Expand Up @@ -856,6 +851,11 @@ impl Shuttle {
};
}

println!(
"Run `cargo shuttle project start` to create a project environment on Shuttle.\n\
Run `cargo shuttle deploy` to deploy your Shuttle service."
);

Ok(())
}

Expand Down
1 change: 0 additions & 1 deletion deployer/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ fqdn = { workspace = true }
futures = { workspace = true }
home = { workspace = true }
hyper = { workspace = true, features = ["client", "http1", "http2", "tcp"] }
# not great, but waiting for WebSocket changes to be merged
hyper-reverse-proxy = { workspace = true }
once_cell = { workspace = true }
opentelemetry = { workspace = true }
Expand Down