A template to get started with writing cross-platforms CLI applications hosted on GitHub.
- CLI app setup with clap
- Optional terminal colours & styling
- CI setup
- Cross-platform binary release via trust
- Shell completion scripts setup
- Various repo housekeeping: changelog, editorconfig etc
All of the above is optional: you can pick only the features you want.
If you want to enable the publication of binaries, you will need to do the following steps first.
You might also need to enable it in Travis/AppVeyor.
Go to https://github.com/settings/tokens/new and create 1 public_repo
tokens, the
name is up to you but should be something like {{project}} Travis
so it is easy to find.
Encrypt the token by using the travis
gem:
$ travis encrypt $TOKEN -r $GH_USER/$GH_REPO
If your repo is using travis.com (likely now), you will also need to pass the --com
flag.
Copy the output somewhere, we will need it later!
Go to https://github.com/settings/tokens/new and create 1 public_repo
tokens, the
name is up to you but should be something like {{project}} AppVeyor
so it is easy to find.
Go to https://ci.appveyor.com/tools/encrypt and encrypt the second GitHub token. As before, you will also need the output later.
This is a kickstart template so you
will need to have kickstart
installed:
$ cargo install kickstart
Once you have it installed and have the encrypted tokens generated above if needed, run:
$ kickstart https://github.com/Keats/rust-cli-template
- Check that the name repo name in the badges in the README match the actual one: it uses the project name by default
- Is there an equivalent to Trust for GitLab?