cargo-rx

cargo-rx is a simple fuzzy finder and Runner for Examples in a [Cargo] project.

This crate provides a single executable: rx. Basically anywhere you would use cargo run --example in a Rust project, try rx instead.

Table of Contents

• Installation
  • From source
  • From binaries
  • Windows
• Features
• Contributing
• License
• Authors

Installation

From source

Ensure that you have a fairly recent version of [rust/cargo] installed. Then, run:

shell $ cargo install cargo-rx

Compiler support: requires rustc 1.58+

From binaries

Check out the [Releases page] for pre-built binaries compatible with various architectures.

Windows

Note that on a Windows environment, you will also need to have [fzf installed] and available in your $PATH variable.

An easy way to install fzf is via [Chocolatey]:

console choco install fzf

There is currently a [feature request] open on skim which proposes adding support for Windows, but this has not been currently implemented yet -- thus, the fzf tool serves as a stand-in alternative for now.

Features

• Fuzzy finder, which leverages [skim] to sort and search for examples in a Cargo project -- when called with just rx.
• Pass arguments after -- to the selected example.
• Automatically [enables required-features] when running an example.
• Play back of most recently run example via the --replay option.
• Automatically enables +nightly toolchain when passed in unstable options to cargo run, such as --unit-graph.

Contributing

Contributions are welcome! Open a pull request to fix a bug, or open an issue to discuss a new feature or change.

Check out the Contributing section in the docs for more info.

License

This project is proudly licensed under the MIT license (LICENSE or http://opensource.org/licenses/MIT).

cargo-rx can be distributed according to the MIT license. Contributions will be accepted under the same license.

Authors

• cargo-rx is brought to you by Ritvik Nag.