Cargo plugin to easily query information from Cargo.toml files

Overview

This plugin helps querying information from a Cargo.toml file and can be used in shell scripts or CI/CD pipelines. The plugin accepts only one flag at a time and returns a single string with the requested value. Some queries like eq. keywords or authors return multiple values which get separated by line breaks (each value on a new line).

This plugin is inspired by cargo-edit and presents itself as a lightweight wrapper around cargo_toml

Contribution

Thanks for your interest - we gratefully welcome contributions.

Questions can be asked in issues. To help us help you get pull requests merged quickly and smoothly, open an issue before submitted large changes. Please keep the contents of pull requests and commits short. Commit messages should include the intent of the commit. cargo-get uses rustfmt for formatting and clippy for linting.

Installation

Ensure that you have a fairly recent version of rust/cargo installed.

$ cargo install cargo-get

(Please check cargo's documentation to learn how cargo install works and how to set up your system so it finds binaries installed by cargo.)

Examples

All Options

```bash $ cargo get -h cargo-get Nicolai Unrein info@auxcontrol.io Query package info from Cargo.toml in a script-friendly way.

USAGE: cargo-get [FLAGS] [OPTIONS] [SUBCOMMAND]

FLAGS: -a, --authors get package authors -e, --edition get package edition -n, --name get package name -o, --homepage get package homepage -k, --keywords get package keywords -l, --license get package license -i, --links get package links -d, --description get package description -c, --categories get package categories -h, --help Prints help information

OPTIONS: --root optional entry point --delimiter specify delimiter for values

SUBCOMMANDS: version get package version help Prints this message or the help of the given subcommand(s) ```

Get Version

```bash $ cargo get version 0.2.1

$ cargo get version --pretty v0.2.1

$ cargo get version --major --minor --patch --pre 0 2 1 alpha2

$ cargo get version --major --minor --delimiter="." 0.2

```

Now it is also easy to run commands like:

bash git tag $(cargo get version --pretty)

Get keywords

bash $ cargo get -k command-line-utilities development-tools::cargo-plugins

Custom delimiter

```bash

Use one of Tab, CR, LF, CRLF or a custom string.

$ cargo get -k --delimiter Tab command-line-utilities development-tools::cargo-plugins

$ cargo get -k --delimiter=" -- " command-line-utilities -- development-tools::cargo-plugins

$ cargo get -k --delimiter=";" command-line-utilities;development-tools::cargo-plugins ```

Optional entry point

```bash

Full path

$ cargo get -n --root="../../some/other/project/Cargo.toml" some-other-project

Directory

$ cargo get -n --root="../../some/other/project" some-other-project

Current directory

$ cargo get -n current-project ```