<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/doc/man/cargo-pkgid.md - fork/cargo @ home-0.5.12</title>
<meta name="description" content="src/doc/man/cargo-pkgid.md in fork/cargo at home-0.5.12.">
<meta property="og:title" content="src/doc/man/cargo-pkgid.md - fork/cargo @ home-0.5.12">
<meta property="og:description" content="src/doc/man/cargo-pkgid.md in fork/cargo at home-0.5.12.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="home-0.5.12" data-tip="4f15cc8882fb34bf70c945e9c8ae91d6c8c91757">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/cargo</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/cargo</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="3293d22f009b1de2b0a6245e7a6adee6d877e01c">Auto merge of #14326 - Ifropc:5707-lock-path, r=weihanglo</span><span class="snapshot-sha sha" data-commit="3293d22f009b1de2b0a6245e7a6adee6d877e01c">3293d22f0</span><time datetime="2024-08-16T14:38:39+00:00" title="2024-08-16 14:38:39 +0000">2024-08-16</time></p>
<header class="topbar"><details class="switcher"><summary>home-0.5.12</summary><div class="menu"><strong>branches</strong><a href="/fork/cargo/ref/master/">master</a><strong>tags</strong><a href="/fork/cargo/ref/0.87.0/">0.87.0</a><a href="/fork/cargo/ref/0.88.0/">0.88.0</a><a href="/fork/cargo/ref/0.89.0/">0.89.0</a><a href="/fork/cargo/ref/0.90.0/">0.90.0</a><a href="/fork/cargo/ref/0.91.0/">0.91.0</a><a href="/fork/cargo/ref/0.92.0/">0.92.0</a><a href="/fork/cargo/ref/0.93.0/">0.93.0</a><a class="current" href="/fork/cargo/ref/home-0.5.12/">home-0.5.12</a><a class="all" href="/fork/cargo/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/cargo/">cargo</a> / <a href="/fork/cargo/ref/home-0.5.12/tree/src/">src</a> / <a href="/fork/cargo/ref/home-0.5.12/tree/src/doc/">doc</a> / <a href="/fork/cargo/ref/home-0.5.12/tree/src/doc/man/">man</a> / <span class="cur">cargo-pkgid.md</span></nav>
<span class="view-stats"><span>2.6 KiB</span><span>100 lines</span></span><span class="actions"><a class="raw" href="/fork/cargo/raw/28a6ea13808b48ba2af81cae4ebd74dd5b937c8a/src/doc/man/cargo-pkgid.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>cargo-pkgid(1)</h1>
<h2>NAME</h2>
<p>cargo-pkgid --- Print a fully qualified package specification</p>
<h2>SYNOPSIS</h2>
<p><code>cargo pkgid</code> [<em>options</em>] [<em>spec</em>]</p>
<h2>DESCRIPTION</h2>
<p>Given a <em>spec</em> 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 <em>spec</em> is ambiguous as to which package it refers to in
the dependency graph. If no <em>spec</em> is given, then the specifier for the local
package is printed.</p>
<p>This command requires that a lockfile is available and dependencies have been
fetched.</p>
<p>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. This specifier is also used by other parts
in Cargo, such as {{man "cargo-metadata" 1}} and <a href="../reference/external-tools.html#json-messages">JSON messages</a> emitted by Cargo.</p>
<p>The format of a <em>spec</em> can be one of the following:</p>
<table><thead><tr><th>SPEC Structure</th><th>Example SPEC</th></tr></thead><tbody>
<tr><td><em>name</em></td><td><code>bitflags</code></td></tr>
<tr><td><em>name</em><code>@</code><em>version</em></td><td><code>bitflags@1.0.4</code></td></tr>
<tr><td><em>url</em></td><td><code>https://github.com/rust-lang/cargo</code></td></tr>
<tr><td><em>url</em><code>#</code><em>version</em></td><td><code>https://github.com/rust-lang/cargo#0.33.0</code></td></tr>
<tr><td><em>url</em><code>#</code><em>name</em></td><td><code>https://github.com/rust-lang/crates.io-index#bitflags</code></td></tr>
<tr><td><em>url</em><code>#</code><em>name</em><code>@</code><em>version</em></td><td><code>https://github.com/rust-lang/cargo#crates-io@0.21.0</code></td></tr>
</tbody></table>
<p>The specification grammar can be found in chapter <a href="../reference/pkgid-spec.html">Package ID Specifications</a>.</p>
<h2>OPTIONS</h2>
<h3>Package Selection</h3>
<p>{{#options}}</p>
<p>{{#option "<code>-p</code> <em>spec</em>" "<code>--package</code> <em>spec</em>" }}
Get the package ID for the given package instead of the current package.
{{/option}}</p>
<p>{{/options}}</p>
<h3>Display Options</h3>
<p>{{#options}}
{{&gt; options-display }}
{{/options}}</p>
<h3>Manifest Options</h3>
<p>{{#options}}</p>
<p>{{&gt; options-manifest-path }}</p>
<p>{{&gt; options-locked }}</p>
<p>{{&gt; options-lockfile-path }}</p>
<p>{{/options}}</p>
<p>{{&gt; section-options-common }}</p>
<p>{{&gt; section-environment }}</p>
<p>{{&gt; section-exit-status }}</p>
<h2>EXAMPLES</h2>
<ol>
<li>
<p>Retrieve package specification for <code>foo</code> package:</p>
<pre><code>cargo pkgid foo
</code></pre>
</li>
<li>
<p>Retrieve package specification for version 1.0.0 of <code>foo</code>:</p>
<pre><code>cargo pkgid foo@1.0.0
</code></pre>
</li>
<li>
<p>Retrieve package specification for <code>foo</code> from crates.io:</p>
<pre><code>cargo pkgid https://github.com/rust-lang/crates.io-index#foo
</code></pre>
</li>
<li>
<p>Retrieve package specification for <code>foo</code> from a local package:</p>
<pre><code>cargo pkgid file:///path/to/local/package#foo
</code></pre>
</li>
</ol>
<h2>SEE ALSO</h2>
<p>{{man "cargo" 1}}, {{man "cargo-generate-lockfile" 1}}, {{man "cargo-metadata" 1}},
<a href="../reference/pkgid-spec.html">Package ID Specifications</a>, <a href="../reference/external-tools.html#json-messages">JSON messages</a></p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>cargo-pkgid(1)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>##</a-p> <a-tt>NAME</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">cargo-pkgid --- Print a fully qualified package specification</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>##</a-p> <a-tt>SYNOPSIS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">`cargo pkgid` [_options_] [_spec_]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>##</a-p> <a-tt>DESCRIPTION</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">Given a _spec_ argument, print out the fully qualified package ID specifier</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">for a package or dependency in the current workspace. This command will</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">generate an error if _spec_ is ambiguous as to which package it refers to in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">the dependency graph. If no _spec_ is given, then the specifier for the local</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">package is printed.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">This command requires that a lockfile is available and dependencies have been</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">fetched.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">A package specifier consists of a name, version, and source URL. You are</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">allowed to use partial specifiers to succinctly match a specific package as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">long as it matches only one package. This specifier is also used by other parts</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">in Cargo, such as {{man &quot;cargo-metadata&quot; 1}} and [JSON messages] emitted by Cargo.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">The format of a _spec_ can be one of the following:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">SPEC Structure             | Example SPEC</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">---------------------------|--------------</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">_name_                     | `bitflags`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">_name_`@`_version_         | `bitflags@1.0.4`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">_url_                      | `https://github.com/rust-lang/cargo`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">_url_`#`_version_          | `https://github.com/rust-lang/cargo#0.33.0`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text">_url_`#`_name_             | `https://github.com/rust-lang/crates.io-index#bitflags`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">_url_`#`_name_`@`_version_ | `https://github.com/rust-lang/cargo#crates-io@0.21.0`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">The specification grammar can be found in chapter [Package ID Specifications].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>##</a-p> <a-tt>OPTIONS</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>###</a-p> <a-tt>Package Selection</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">{{#options}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">{{#option &quot;`-p` _spec_&quot; &quot;`--package` _spec_&quot; }}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">Get the package ID for the given package instead of the current package.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">{{/option}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">{{/options}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>###</a-p> <a-tt>Display Options</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">{{#options}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text">{{&gt; options-display }}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">{{/options}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>###</a-p> <a-tt>Manifest Options</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">{{#options}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">{{&gt; options-manifest-path }}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text">{{&gt; options-locked }}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text">{{&gt; options-lockfile-path }}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text">{{/options}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text">{{&gt; section-options-common }}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text">{{&gt; section-environment }}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text">{{&gt; section-exit-status }}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>##</a-p> <a-tt>EXAMPLES</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>1. </a-p>Retrieve package specification for `foo` package:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>   </a-p><a-tl>    cargo pkgid foo</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>2. Retrieve package specification for version 1.0.0 of `foo`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>   </a-p><a-tl>    cargo pkgid foo@1.0.0</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>3. Retrieve package specification for `foo` from crates.io:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>   </a-p><a-tl>    cargo pkgid https://github.com/rust-lang/crates.io-index#foo</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>4. Retrieve package specification for `foo` from a local package:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>   </a-p><a-tl>    cargo pkgid file:///path/to/local/package#foo</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>## </a-p><a-tt>SEE ALSO</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>{{man &quot;cargo&quot; 1}}, {{man &quot;cargo-generate-lockfile&quot; 1}}, {{man &quot;cargo-metadata&quot; 1}},</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>[Package ID Specifications], [JSON messages]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-tu>[Package ID Specifications]</a-tu><a-p>: </a-p><a-tu>../reference/pkgid-spec.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-tu>[JSON messages]</a-tu><a-p>: </a-p><a-tu>../reference/external-tools.html#json-messages</a-tu></span></span></pre></div></div>
</main>
</body>
</html>
