diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/vagrant/cli%2Flogin.html | |
new repository
Diffstat (limited to 'devdocs/vagrant/cli%2Flogin.html')
| -rw-r--r-- | devdocs/vagrant/cli%2Flogin.html | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/devdocs/vagrant/cli%2Flogin.html b/devdocs/vagrant/cli%2Flogin.html new file mode 100644 index 00000000..ad5485fb --- /dev/null +++ b/devdocs/vagrant/cli%2Flogin.html @@ -0,0 +1,19 @@ +<h1 id="login"> Login </h1> <p><strong>Command: <code>vagrant login</code></strong></p> <p>The login command is used to authenticate with the <a href="https://www.vagrantup.com/docs/vagrant-cloud">HashiCorp's Vagrant Cloud</a> server. Logging in is only necessary if you are accessing protected boxes or using <a href="../share/index">Vagrant Share</a>.</p> <p><strong>Logging in is not a requirement to use Vagrant.</strong> The vast majority of Vagrant does <em>not</em> require a login. Only certain features such as protected boxes or <a href="../share/index">Vagrant Share</a> require a login.</p> <p>The reference of available command-line flags to this command is available below.</p> <h2 id="options"> Options </h2> <ul> <li> +<p><a href="#check"><code>--check</code></a> - This will check if you are logged in. In addition to outputting whether you are logged in or not, the command will have exit status 0 if you are logged in, and exit status 1 if you are not.</p> </li> <li> +<p><a href="#logout"><code>--logout</code></a> - This will log you out if you are logged in. If you are already logged out, this command will do nothing. It is not an error to call this command if you are already logged out.</p> </li> <li> +<p><a href="#token"><code>--token</code></a> - This will set the Vagrant Cloud login token manually to the provided string. It is assumed this token is a valid Vagrant Cloud access token.</p> </li> </ul> <h2 id="examples"> Examples </h2> <p>Securely authenticate to Vagrant Cloud using a username and password:</p> <div class="highlight"><pre class="highlight plaintext">$ vagrant login +# ... +Vagrant Cloud username: +Vagrant Cloud password: +</pre></div> +<p>Check if the current user is authenticated:</p> <div class="highlight"><pre class="highlight plaintext">$ vagrant login --check +You are already logged in. +</pre></div> +<p>Securely authenticate with Vagrant Cloud using a token:</p> <div class="highlight"><pre class="highlight plaintext">$ vagrant login --token ABCD1234 +The token was successfully saved. +</pre></div><div class="_attribution"> + <p class="_attribution-p"> + © 2010–2018 Mitchell Hashimoto<br>Licensed under the MPL 2.0 License.<br> + <a href="https://www.vagrantup.com/docs/cli/login.html" class="_attribution-link">https://www.vagrantup.com/docs/cli/login.html</a> + </p> +</div> |