Crate cargo_hoist

Source
Expand description

§cargo-hoist

CI Build Status Release Tag Build Status License Docs Latest Version rustc 1.70+

Dead simple cargo subcommand to hoist cargo-built binaries into scope. https://github.com/refcell/cargo-hoist/labels/stable

Install | User Docs | Crate Docs | Reference | Contributing | License

§What is cargo-hoist?

cargo-hoist is an ultra lightweight, dead simple cargo subcommand that memoizes cargo-built binaries using a global toml cache file. Since the global toml file contains a memoized list of the built binary paths, the hoist subcommand can then be used to manipulate cargo-built binaries in a whole variety of ways.

Primarily, binaries can be pulled into the current working directory using cargo hoist <bin name> (the default, flagless hoist command). To load the binary into path, you can run cargo hoist <bin name> --path.

Often, it’s added overhead to remember where your binary is built within the target/.. directories. cargo-hoist makes it easy to find locally built binaries using the --list (or -l shorthand) flag.

§Usage

Install cargo-hoist using cargo.

cargo install cargo-hoist

§CLI Flags

Below is a manual output for v0.1.11. To generate a more up-to-date output, run cargo hoist --help.

Dead simple, memoized cargo subcommand to hoist cargo-built binaries into scope.

Usage: cargo hoist [OPTIONS] [COMMAND]

Commands:
  hoist     Hoist dependencies
  list      List registered dependencies
  search    Search for a binary in the hoist toml registry
  nuke      Nuke wipes the hoist toml registry
  register  Registers a binary in the global hoist toml registry
  help      Print this message or the help of the given subcommand(s)

Options:
  -v, --verbosity...  Verbosity level (0-4). Default: 0 (ERROR)
  -q, --quiet         Suppresses standard output
  -h, --help          Print help
  -V, --version       Print version

§Contributing

Contributions of all forms are welcome and encouraged!

Please check existing issues for similar feature requests or bug reports.

Otherwise, feel free to open an issue if no relevant issue already exists.

§License

This project is licensed under the MIT License.

Free and open-source, forever. All our rust are belong to you.

Modules§

binaries
Hoisted Binaries
cli
CLI Logic
executables
Executables
project
Project
registry
Hoist Registry
shell
Shell Utilities
telemetry
Telemetry
utils
Utilities for working with Vec and std::collections::HashSet.

Structs§

Args
Command line arguments

Enums§

Command
Subcommands

Functions§

run
Run the main hoist command