<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>credential/cargo-credential-1password/README.md - fork/cargo @ 0.93.0</title>
<meta name="description" content="credential/cargo-credential-1password/README.md in fork/cargo at 0.93.0.">
<meta property="og:title" content="credential/cargo-credential-1password/README.md - fork/cargo @ 0.93.0">
<meta property="og:description" content="credential/cargo-credential-1password/README.md in fork/cargo at 0.93.0.">
<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="0.93.0" data-tip="344c4567c634a25837e3c3476aac08af84cf9203">
<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="2652990f5f37c14545bfca387ae5cf38296fae94">Auto merge of #14600 - epage:charter-crates, r=weihanglo</span><span class="snapshot-sha sha" data-commit="2652990f5f37c14545bfca387ae5cf38296fae94">2652990f5</span><time datetime="2024-10-02T18:58:49+00:00" title="2024-10-02 18:58:49 +0000">2024-10-02</time></p>
<header class="topbar"><details class="switcher"><summary>0.93.0</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 class="current" href="/fork/cargo/ref/0.93.0/">0.93.0</a><a 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/0.93.0/tree/credential/">credential</a> / <a href="/fork/cargo/ref/0.93.0/tree/credential/cargo-credential-1password/">cargo-credential-1password</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.4 KiB</span><span>37 lines</span></span><span class="actions"><a class="raw" href="/fork/cargo/raw/74bf4c4eeb0432b8e2107d170b1d1c3cd4b3bd67/credential/cargo-credential-1password/README.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-credential-1password</h1>
<p>A Cargo <a href="https://doc.rust-lang.org/stable/cargo/reference/registry-authentication.html">credential provider</a> for <a href="https://1password.com/">1password</a>.</p>
<blockquote>
<p>This crate is maintained by the Cargo team as a part of an experiment around
1password integration. We encourage people to try to use this crate in their projects and
provide feedback through <a href="https://github.com/rust-lang/cargo/issues/">issues</a>, but do not
guarantee long term maintenance.</p>
</blockquote>
<h2>Usage</h2>
<p><code>cargo-credential-1password</code> uses the 1password <code>op</code> CLI to store the token. You
must install the <code>op</code> CLI from the <a href="https://1password.com/downloads/command-line/">1password
website</a>.</p>
<p>Afterward you need to configure <code>cargo</code> to use <code>cargo-credential-1password</code> as
the credential provider. You can do this by adding something like the following
to your <a href="https://doc.rust-lang.org/stable/cargo/reference/registry-authentication.html">cargo config file</a>:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>registry</a-pr><a-p>]</a-p>
<a-pr>global-credential-providers</a-pr> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;cargo-credential-1password --account my.1password.com&quot;</a-s><a-p>]</a-p></pre>
<p>Finally, run <code>cargo login</code> to save your registry token in 1password.</p>
<h2>CLI Arguments</h2>
<p><code>cargo-credential-1password</code> supports the following command-line arguments:</p>
<ul>
<li><code>--account</code>: The account name to use. For a list of available accounts,
run <code>op account list</code>.</li>
<li><code>--vault</code>: The vault name to use. For a list of available vaults,
run <code>op vault list</code>.</li>
</ul>
</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-credential-1password</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 Cargo [credential provider] for [1password].</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"><a-p>&gt; </a-p>This crate is maintained by the Cargo team as a part of an experiment around</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>&gt; </a-p>1password integration. We encourage people to try to use this crate in their projects and</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>&gt; </a-p>provide feedback through [issues](https://github.com/rust-lang/cargo/issues/), but do not</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>&gt; </a-p>guarantee long term maintenance.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>##</a-p> <a-tt>Usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">`cargo-credential-1password` uses the 1password `op` CLI to store the token. You</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">must install the `op` CLI from the [1password</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">website](https://1password.com/downloads/command-line/).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">Afterward you need to configure `cargo` to use `cargo-credential-1password` as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">the credential provider. You can do this by adding something like the following</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">to your [cargo config file][credential provider]:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>[</a-p><a-pr>registry</a-pr><a-p>]</a-p></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-p>global-credential-providers </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;cargo-credential-1password --account my.1password.com&quot;</a-s><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>Finally, run `cargo login` to save your registry token in 1password.</a-p></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"><a-p>## </a-p><a-tt>CLI Arguments</a-tt></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"><a-p>`cargo-credential-1password` supports the following command-line arguments:</a-p></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"><a-p>* `--account`: The account name to use. For a list of available accounts, </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>  run `op account list`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>* `--vault`: The vault name to use. For a list of available vaults,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>  run `op vault list`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-tu>[1password]</a-tu><a-p>: </a-p><a-tu>https://1password.com/</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-tu>[credential provider]</a-tu><a-p>: </a-p><a-tu>https://doc.rust-lang.org/stable/cargo/reference/registry-authentication.html</a-tu></span></span></pre></div></div>
</main>
</body>
</html>
