rust-starter is a starter boilerplate to create a Rust CLI application. It comes with a battery of components like argument parsing and configuration. It also has different tooling to create your binary, or automate your build process.
Table of Contents
What's New?
Version 2.0.0
What's new in Version 2.0?
- Upgrade to Clap 4.x
- Shell Completion
- Merge AppConfig with Clap/Cli arguments
- use ConfigBuilder instead of Config
- rustfmt update
- Github release action
Planned for a 2.x release
- Journald/Syslog as features
- Fix CI/CD actions and Docker image
About
rust-starter is an empty Rust CLI application with libraries, and few defaults. The goal is to help you bootstrap your next CLI project as quickly as possible while ensuring you make use of the best tools and best-practices that are available today.
There is no configuration required (though we recommend you check all the possible configurations possible). An empty clone will compile, and has a few sample commands. You can start coding right away!
FAQ
For the Full FAQ, check the website
Features
- Clap for Command Line Argument parsing.
- Error Chaining with Failure.
- Configuration management with config-rs.
- Multi-Drain, async Logging with slog.
- Static binaries with rust-musl-builder.
- CI/CD through Github actions.
- Code Coverage, Justfile, etc..
- MIT License.
Quick Bootstrapping
rust-starter should compile and run as is. You just need to clone the repository. A cargo-generate template is also available. For a more detailed introduction, check the Getting Started guide.
How to Contribute
Details on how to contribute can be found in the CONTRIBUTING.md file.
Versioning
Rust Starter stricltly adheres to the SemVer Semantic Versioning.
License
rust-starter is licensed under the MIT license. Please read the LICENSE file in this repository for more information.