cargo-pkgid man page

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 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:

Table 1. SPEC Query Format

Options

Package Selection

-p SPEC, --package SPEC

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 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:

  • auto (default): Automatically detect if color support is available on the terminal.
  • always: Always display colors.
  • 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 in the current directory or any parent directory for the Cargo.toml file.

--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 out-of-date.

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.

--offline

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

-h, --help

Prints help information.

-Z FLAG...

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

Environment

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

Exit Status

0

Cargo succeeded.

101

Cargo failed to complete.

Examples

  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

See Also

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

Referenced By

cargo(1), cargo-bench(1), cargo-build(1), cargo-check(1), cargo-clean(1), cargo-doc(1), cargo-fix(1), cargo-run(1), cargo-rustc(1), cargo-rustdoc(1), cargo-test(1), cargo-uninstall(1), cargo-update(1).

2019-04-16 Ā