How to tell the version number of the Rust crate I'm in?

Question

Is there a robust way, maybe something in cargo CLI, to get the version of the crate?

I can grep on Cargo.toml, but I'm looking for something that won't break in 6 months.

Is there a better way?

What do you need this for? Have you tried cargo tree --depth 0? — PitaJ
– PitaJ, Commented Jan 5, 2023 at 18:59
Are you needing just a number (well a string, since a number cant have multiple periods) or are you fine with a tiny bit of extra data? cargo pkgid gives files:///Users/sus/code/project#0.1.0 — Samathingamajig
– Samathingamajig, Commented Jan 5, 2023 at 19:02
There's also cargo metadata, but it is verbose and not geared to the current package if you're in a workspace. — kmdreko
– kmdreko, Commented Jan 5, 2023 at 19:17
If you need it in a build.rs script or embedded in an application, there's a CARGO_PKG_VERSION environment variable. — kmdreko
– kmdreko, Commented Jan 5, 2023 at 19:18

kmdreko · Accepted Answer · 2023-01-05 19:24:28Z

10

The general way to get metadata about your package or workspace is via the cargo metadata command, which produces a JSON output with your workspace packages, dependencies, targets, etc. However it is very verbose.

If you are not in a workspace, then you can simply get the version of the first package excluding dependencies (parsing with jq):

> cargo metadata --format-version=1 --no-deps | jq '.packages[0].version'
"0.1.0"

If you are in a workspace however, then there will be multiple packages (even after excluding dependencies) and appears to be in alphabetical order. You'd need to know the package's name:

> cargo metadata --format-version=1 --no-deps | jq '.packages[] | select(.name == "PACKAGE_NAME") | .version'
"0.1.0"

answered Jan 5, 2023 at 19:24

kmdreko

65.4k6 gold badges106 silver badges178 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Marcono1234 Over a year ago

When using jq you might also want to use --raw-output to remove the quotes around the version number. Maybe would also be good to set --exit-status to fail if (for some reason) the version number could not be extracted. See also the jq manual.

Samathingamajig · Accepted Answer · 2023-01-05 20:04:03Z

8

The simplest answer is

cargo pkgid

This outputs

files:///Users/sus/code/project#0.1.0

If you want this as just the version part, you can pipe this to cut (or handle it yourself in your programming language of choice)

cargo pkgid | cut -d "#" -f2

answered Jan 5, 2023 at 20:04

Samathingamajig

13.5k3 gold badges19 silver badges46 bronze badges

2 Comments

João Haas Feb 12 at 15:21

Note that if package.name in Cargo.toml is different than the project folder name, the output will be slightly different: path+file:///Users/sus/code/folder_name#[email protected]

João Haas Feb 12 at 15:30

cargo pkgid | awk -F'[#@]' '{print $NF}' should work regardless of folder name

Collectives™ on Stack Overflow

How to tell the version number of the Rust crate I'm in?

2 Answers 2

1 Comment

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related