cargo-get 0.3.1

Cargo plugin to easily query information from Cargo.toml files
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

**Cargo plugin to easily query information from Cargo.toml files**

[![crates.io](https://img.shields.io/crates/v/cargo-get.svg)](https://crates.io/crates/cargo-get)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/nicolaiunrein/cargo-get/CI)

### 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](https://github.com/killercup/cargo-edit) and presents itself as a lightweight wrapper around [cargo_toml](https://gitlab.com/crates.rs/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 <Path>                                  optional entry point
        --delimiter <Tab | CR | LF | CRLF | String>    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
```