cargo pkgid

NAME

cargo-pkgid - Print a fully qualified package specification

SYNOPSIS

cargo pkgid [OPTIONS] [SPEC]

DESCRIPTION

Given a SPEC argument, print out the fully qualified package ID specifierfor a package or dependency in the current workspace. This command willgenerate an error if SPEC is ambiguous as to which package it refers to inthe dependency graph. If no SPEC is given, then the specifier for the localpackage is printed.

This command requires that a lockfile is available and dependencies have beenfetched.

A package specifier consists of a name, version, and source URL. You areallowed to use partial specifiers to succinctly match a specific package aslong as it matches only one package. The format of a SPEC can be one of thefollowing:

OPTIONS

Package Selection

• -pSPEC
• —packageSPEC
• Get the package ID for the given package instead of the current package.

Display Options

• -v
• —verbose

• Use verbose output. May be specified twice for "very verbose" output whichincludes extra output such as dependency warnings and build script output.May also be specified with the term.verboseconfig value.

• -q

• —quiet

• No output printed to stdout.

• —colorWHEN

• Control when colored output is used. Valid values:

• auto (default): Automatically detect if color support is available on theterminal.

• always: Always display colors.

• never: Never display colors.

May also be specified with the term.colorconfig value.

Manifest Options

• —manifest-pathPATH

• Path to the Cargo.toml file. By default, Cargo searches in the currentdirectory or any parent directory for the Cargo.toml file.

• —frozen

• —locked
• Either of these flags requires that the Cargo.lock file isup-to-date. If the lock file is missing, or it needs to be updated, Cargo willexit with an error. The —frozen flag also prevents Cargo fromattempting to access the network to determine if it is out-of-date.

These may be used in environments where you want to assert that theCargo.lock file is up-to-date (such as a CI build) or want to avoid networkaccess.

• —offline
• Prevents Cargo from accessing the network for any reason. Without thisflag, Cargo will stop with an error if it needs to access the network andthe network is not available. With this flag, Cargo will attempt toproceed without the network if possible.

Beware that this may result in different dependency resolution than onlinemode. Cargo will restrict itself to crates that are downloaded locally, evenif there might be a newer version as indicated in the local copy of the index.See the cargo-fetch(1) command to download dependencies before goingoffline.

May also be specified with the net.offline config value.

Common Options

• -h
• —help

• Prints help information.

• -ZFLAG…​

• Unstable (nightly-only) flags to Cargo. Run cargo -Z help fordetails.

ENVIRONMENT

See the reference fordetails on environment variables that Cargo reads.

Exit Status

• 0

• Cargo succeeded.

• 101

• Cargo failed to complete.

EXAMPLES

• Retrieve package specification for foo package:

cargo pkgid foo

• Retrieve package specification for version 1.0.0 of foo:

cargo pkgid foo:1.0.0

• Retrieve package specification for foo from crates.io:

cargo pkgid https://github.com/rust-lang/crates.io-index#foo

SEE ALSO

cargo(1), cargo-generate-lockfile(1), cargo-metadata(1)