Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022

cargo-pkgid (1)


cargo-pkgid - Print a fully qualified package specification


cargo pkgid [options] [spec]


CARGO-PKGID(1)              General Commands Manual             CARGO-PKGID(1)

       cargo-pkgid - Print a fully qualified package specification

       cargo pkgid [options] [spec]

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

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

       A package specifier consists of a name, version, and source URL. You
       are allowed to use partial specifiers to succinctly match a specific
       package as long as it matches only one package. The format of a spec
       can be one of the following:

       |SPEC Structure   | Example SPEC                                          |
       |name             | bitflags                                              |
       |name:version     | bitflags:1.0.4                                        |
       |url              | https://github.com/rust-lang/cargo                    |
       |url#version      | https://github.com/rust-lang/cargo#0.33.0             |
       |url#name         | https://github.com/rust-lang/crates.io-index#bitflags |
       |url#name:version | https://github.com/rust-lang/cargo#crates-io:0.21.0   |

   Package Selection
       -p spec, --package spec
           Get the package ID for the given package instead of the current

   Display Options
       -v, --verbose
           Use verbose output. May be specified twice for "very verbose"
           output which includes extra output such as dependency warnings and
           build script output. May also be specified with the term.verbose
           config value

       -q, --quiet
           No output printed to stdout.

       --color when
           Control when colored output is used. Valid values:

           o  auto (default): Automatically detect if color support is
               available on the terminal.

           o  always: Always display colors.

           o  never: Never display colors.

           May also be specified with the term.color config value

   Manifest Options
       --manifest-path path
           Path to the Cargo.toml file. By default, Cargo searches for the
           Cargo.toml file in the current directory or any parent directory.

       --frozen, --locked
           Either of these flags requires that the Cargo.lock file is
           up-to-date. If the lock file is missing, or it needs to be updated,
           Cargo will exit with an error. The --frozen flag also prevents
           Cargo from attempting to access the network to determine if it is

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

           Prevents Cargo from accessing the network for any reason. Without
           this flag, Cargo will stop with an error if it needs to access the
           network and the network is not available. With this flag, Cargo
           will attempt to proceed without the network if possible.

           Beware that this may result in different dependency resolution than
           online mode. Cargo will restrict itself to crates that are
           downloaded locally, even if 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 going offline.

           May also be specified with the net.offline config value

   Common Options
           If Cargo has been installed with rustup, and the first argument to
           cargo begins with +, it will be interpreted as a rustup toolchain
           name (such as +stable or +nightly). See the rustup documentation
           <https://rust-lang.github.io/rustup/overrides.html> for more
           information about how toolchain overrides work.

       -h, --help
           Prints help information.

       -Z flag
           Unstable (nightly-only) flags to Cargo. Run cargo -Z help for

       See the reference
       for details on environment variables that Cargo reads.

       o  0: Cargo succeeded.

       o  101: Cargo failed to complete.

        1. Retrieve package specification for foo package:

               cargo pkgid foo

        2. Retrieve package specification for version 1.0.0 of foo:

               cargo pkgid foo:1.0.0

        3. Retrieve package specification for foo from crates.io:

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

        4. Retrieve package specification for foo from a local package:

               cargo pkgid file:///path/to/local/package#foo

       See attributes(7) for descriptions of the following attributes:

       |Availability   | developer/rust/cargo |
       |Stability      | Volatile             |

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

       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-

       This software was built from source available at
       https://github.com/oracle/solaris-userland. The original community
       source was downloaded from  https://static.rust-

       Further information about this software can be found on the open source
       community website at http://www.rust-lang.org/.