| = cargo-metadata(1) |
| :idprefix: cargo_metadata_ |
| :doctype: manpage |
| :source-highlighter: highlightjs |
| |
| == NAME |
| |
| cargo-metadata - Machine-readable metadata about the current package |
| |
| == SYNOPSIS |
| |
| `cargo metadata [_OPTIONS_]` |
| |
| == DESCRIPTION |
| |
| Output the resolved dependencies of a package, the concrete used versions |
| including overrides, in JSON to stdout. |
| |
| It is recommended to include the `--format-version` flag to future-proof |
| your code to ensure the output is in the format you are expecting. |
| |
| See the link:https://crates.io/crates/cargo_metadata[cargo_metadata crate] |
| for a Rust API for reading the metadata. |
| |
| == OUTPUT FORMAT |
| |
| The output has the following format: |
| |
| [source,javascript] |
| ---- |
| { |
| /* Array of all packages in the workspace. |
| It also includes all feature-enabled dependencies unless --no-deps is used. |
| */ |
| "packages": [ |
| { |
| /* The name of the package. */ |
| "name": "my-package", |
| /* The version of the package. */ |
| "version": "0.1.0", |
| /* The Package ID, a unique identifier for referring to the package. */ |
| "id": "my-package 0.1.0 (path+file:///path/to/my-package)", |
| /* The license value from the manifest, or null. */ |
| "license": "MIT/Apache-2.0", |
| /* The license-file value from the manifest, or null. */ |
| "license_file": "LICENSE", |
| /* The description value from the manifest, or null. */ |
| "description": "Package description.", |
| /* The source ID of the package. This represents where |
| a package is retrieved from. |
| This is null for path dependencies and workspace members. |
| For other dependencies, it is a string with the format: |
| - "registry+URL" for registry-based dependencies. |
| Example: "registry+https://github.com/rust-lang/crates.io-index" |
| - "git+URL" for git-based dependencies. |
| Example: "git+https://github.com/rust-lang/cargo?rev=5e85ba14aaa20f8133863373404cb0af69eeef2c#5e85ba14aaa20f8133863373404cb0af69eeef2c" |
| */ |
| "source": null, |
| /* Array of dependencies declared in the package's manifest. */ |
| "dependencies": [ |
| { |
| /* The name of the dependency. */ |
| "name": "bitflags", |
| /* The source ID of the dependency. May be null, see |
| description for the package source. |
| */ |
| "source": "registry+https://github.com/rust-lang/crates.io-index", |
| /* The version requirement for the dependency. |
| Dependencies without a version requirement have a value of "*". |
| */ |
| "req": "^1.0", |
| /* The dependency kind. |
| "dev", "build", or null for a normal dependency. |
| */ |
| "kind": null, |
| /* If the dependency is renamed, this is the new name for |
| the dependency as a string. null if it is not renamed. |
| */ |
| "rename": null, |
| /* Boolean of whether or not this is an optional dependency. */ |
| "optional": false, |
| /* Boolean of whether or not default features are enabled. */ |
| "uses_default_features": true, |
| /* Array of features enabled. */ |
| "features": [], |
| /* The target platform for the dependency. |
| null if not a target dependency. |
| */ |
| "target": "cfg(windows)", |
| /* A string of the URL of the registry this dependency is from. |
| If not specified or null, the dependency is from the default |
| registry (crates.io). |
| */ |
| "registry": null |
| } |
| ], |
| /* Array of Cargo targets. */ |
| "targets": [ |
| { |
| /* Array of target kinds. |
| - lib targets list the `crate-type` values from the |
| manifest such as "lib", "rlib", "dylib", |
| "proc-macro", etc. (default ["lib"]) |
| - binary is ["bin"] |
| - example is ["example"] |
| - integration test is ["test"] |
| - benchmark is ["bench"] |
| - build script is ["custom-build"] |
| */ |
| "kind": [ |
| "bin" |
| ], |
| /* Array of crate types. |
| - lib and example libraries list the `crate-type` values |
| from the manifest such as "lib", "rlib", "dylib", |
| "proc-macro", etc. (default ["lib"]) |
| - all other target kinds are ["bin"] |
| */ |
| "crate_types": [ |
| "bin" |
| ], |
| /* The name of the target. */ |
| "name": "my-package", |
| /* Absolute path to the root source file of the target. */ |
| "src_path": "/path/to/my-package/src/main.rs", |
| /* The Rust edition of the target. |
| Defaults to the package edition. |
| */ |
| "edition": "2018", |
| /* Array of required features. |
| This property is not included if no required features are set. |
| */ |
| "required-features": ["feat1"] |
| } |
| ], |
| /* Set of features defined for the package. |
| Each feature maps to an array of features or dependencies it |
| enables. |
| */ |
| "features": { |
| "default": [ |
| "feat1" |
| ], |
| "feat1": [], |
| "feat2": [] |
| }, |
| /* Absolute path to this package's manifest. */ |
| "manifest_path": "/path/to/my-package/Cargo.toml", |
| /* Package metadata. |
| This is null if no metadata is specified. |
| */ |
| "metadata": { |
| "docs": { |
| "rs": { |
| "all-features": true |
| } |
| } |
| }, |
| /* Array of authors from the manifest. |
| Empty array if no authors specified. |
| */ |
| "authors": [ |
| "Jane Doe <user@example.com>" |
| ], |
| /* Array of categories from the manifest. */ |
| "categories": [ |
| "command-line-utilities" |
| ], |
| /* Array of keywords from the manifest. */ |
| "keywords": [ |
| "cli" |
| ], |
| /* The readme value from the manifest or null if not specified. */ |
| "readme": "README.md", |
| /* The repository value from the manifest or null if not specified. */ |
| "repository": "https://github.com/rust-lang/cargo", |
| /* The default edition of the package. |
| Note that individual targets may have different editions. |
| */ |
| "edition": "2018", |
| /* Optional string that is the name of a native library the package |
| is linking to. |
| */ |
| "links": null, |
| } |
| ], |
| /* Array of members of the workspace. |
| Each entry is the Package ID for the package. |
| */ |
| "workspace_members": [ |
| "my-package 0.1.0 (path+file:///path/to/my-package)", |
| ], |
| /* The resolved dependency graph, with the concrete versions and features |
| selected. The set depends on the enabled features. |
| This is null if --no-deps is specified. |
| */ |
| "resolve": { |
| /* Array of nodes within the dependency graph. |
| Each node is a package. |
| */ |
| "nodes": [ |
| { |
| /* The Package ID of this node. */ |
| "id": "my-package 0.1.0 (path+file:///path/to/my-package)", |
| /* The dependencies of this package, an array of Package IDs. */ |
| "dependencies": [ |
| "bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)" |
| ], |
| /* The dependencies of this package. This is an alternative to |
| "dependencies" which contains additional information. In |
| particular, this handles renamed dependencies. |
| */ |
| "deps": [ |
| { |
| /* The name of the dependency's library target. |
| If this is a renamed dependency, this is the new |
| name. |
| */ |
| "name": "bitflags", |
| /* The Package ID of the dependency. */ |
| "pkg": "bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)" |
| } |
| ], |
| /* Array of features enabled on this package. */ |
| "features": [ |
| "default" |
| ] |
| } |
| ], |
| /* The root package of the workspace. |
| This is null if this is a virtual workspace. Otherwise it is |
| the Package ID of the root package. |
| */ |
| "root": "my-package 0.1.0 (path+file:///path/to/my-package)" |
| }, |
| /* The absolute path to the build directory where Cargo places its output. */ |
| "target_directory": "/path/to/my-package/target", |
| /* The version of the schema for this metadata structure. |
| This will be changed if incompatible changes are ever made. |
| */ |
| "version": 1, |
| /* The absolute path to the root of the workspace. */ |
| "workspace_root": "/path/to/my-package" |
| } |
| ---- |
| |
| == OPTIONS |
| |
| === Output Options |
| |
| *--no-deps*:: |
| Output information only about the workspace members and don't fetch |
| dependencies. |
| |
| *--format-version* _VERSION_:: |
| Specify the version of the output format to use. Currently `1` is the only |
| possible value. |
| |
| include::options-features.adoc[] |
| |
| === Display Options |
| |
| include::options-display.adoc[] |
| |
| === Manifest Options |
| |
| include::options-manifest-path.adoc[] |
| |
| include::options-locked.adoc[] |
| |
| === Common Options |
| |
| include::options-common.adoc[] |
| |
| include::section-environment.adoc[] |
| |
| include::section-exit-status.adoc[] |
| |
| == EXAMPLES |
| |
| . Output JSON about the current package: |
| |
| cargo metadata --format-version=1 |
| |
| == SEE ALSO |
| man:cargo[1] |
