🦀 Rust CLI Template

This is a template repository for a command-line application built with Rust.

Features

• 🚀 Modern Stack: Built with Rust 2024 edition for performance and safety
• 🛠️ CLI Framework: Clap with derive macros for ergonomic argument parsing
• ⚠️ Error Handling: thiserror for custom error types
• 🔒 Safety:
  • Unsafe code forbidden via lint
  • Strict Clippy lints (pedantic, nursery, cargo)
• ⚡ Optimized Builds:
  • LTO (Link-Time Optimization) enabled
  • Single codegen unit for maximum optimization
  • Binary stripping for smaller size
  • Panic abort for reduced binary size
• 🛠️ Developer Experience:
  • Comprehensive Clippy configuration
  • Cargo metadata for crates.io publishing
  • Easy spin up with Tilt

Prerequisites

• Rust 1.85+

Local Development

Installation

cargo build

Running

cargo run -- --help

Testing

cargo test

Linting

cargo clippy

Installation

From crates.io

cargo install {{project-name}}

From source

cargo install --path .

Usage

{{binary-name}} --help

Publishing

1. Update version in Cargo.toml
2. Update CHANGELOG.md
3. Publish to crates.io:

cargo publish

License

The code in this repository is licensed under MIT, © Omni LLC. See LICENSE.md for more information.