63 lines
1.8 KiB
Plaintext
63 lines
1.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: vagrant login - Command-Line Interface
|
|
sidebar_title: login
|
|
description: |-
|
|
The "vagrant login" command is used to authenticate Vagrant with HashiCorp's
|
|
Vagrant Cloud service to use features like private boxes and "vagrant push".
|
|
---
|
|
|
|
# Login
|
|
|
|
**Command: `vagrant login`**
|
|
|
|
The login command is used to authenticate with the
|
|
[HashiCorp's Vagrant Cloud](/docs/vagrant-cloud) server. Logging in is only
|
|
necessary if you are accessing protected boxes or using
|
|
[Vagrant Share](/docs/share/).
|
|
|
|
**Logging in is not a requirement to use Vagrant.** The vast majority
|
|
of Vagrant does _not_ require a login. Only certain features such as protected
|
|
boxes or [Vagrant Share](/docs/share/) require a login.
|
|
|
|
The reference of available command-line flags to this command
|
|
is available below.
|
|
|
|
## Options
|
|
|
|
- `--check` - 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.
|
|
|
|
- `--logout` - 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.
|
|
|
|
- `--token` - 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.
|
|
|
|
## Examples
|
|
|
|
Securely authenticate to Vagrant Cloud using a username and password:
|
|
|
|
```shell-session
|
|
$ vagrant login
|
|
# ...
|
|
Vagrant Cloud username:
|
|
Vagrant Cloud password:
|
|
```
|
|
|
|
Check if the current user is authenticated:
|
|
|
|
```shell-session
|
|
$ vagrant login --check
|
|
You are already logged in.
|
|
```
|
|
|
|
Securely authenticate with Vagrant Cloud using a token:
|
|
|
|
```shell-session
|
|
$ vagrant login --token ABCD1234
|
|
The token was successfully saved.
|
|
```
|