Sha256: 66949e26810881fb0ff302b2210339b07579fa968cafdfbad5c839ad61c0a545

Contents?: true

Size: 1.71 KB

Versions: 8

Compression:

Stored size: 1.71 KB

Contents

---
layout: "docs"
page_title: "vagrant login - Command-Line Interface"
sidebar_current: "cli-login"
description: |-
  The "vagrant login" command is used to authenticate Vagrant with HashiCorp's
  Atlas 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 Atlas](/docs/other/atlas.html) server. Logging 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 Atlas login token manually to the provided
  string. It is assumed this token is a valid Atlas access token.


## Examples

Securely authenticate to Atlas using a username and password:

```text
$ vagrant login
# ...
Atlas username:
Atlas password:
```

Check if the current user is authenticated:

```text
$ vagrant login --check
You are already logged in.
```

Securely authenticate with Atlas using a token:

```text
$ vagrant login --token ABCD1234
The token was successfully saved.
```

Version data entries

8 entries across 8 versions & 2 rubygems

Version Path
vagrant-aws-mkubenka-0.7.2.pre.14 vendor/bundle/ruby/2.3.0/bundler/gems/vagrant-5333e60e2d38/website/source/docs/cli/login.html.md
vagrant-aws-mkubenka-0.7.2.pre.11 vendor/bundle/ruby/2.3.0/bundler/gems/vagrant-5333e60e2d38/website/source/docs/cli/login.html.md
vagrant-aws-mkubenka-0.7.2.pre.10 vendor/bundle/ruby/2.3.0/bundler/gems/vagrant-5333e60e2d38/website/source/docs/cli/login.html.md
vagrant-aws-mkubenka-0.7.2.pre.9 vendor/bundle/ruby/2.3.0/bundler/gems/vagrant-5333e60e2d38/website/source/docs/cli/login.html.md
vagrant-compose-yaml-0.1.3 vendor/bundle/ruby/2.2.0/bundler/gems/vagrant-dbb756c7b6da/website/source/docs/cli/login.html.md
vagrant-compose-yaml-0.1.2 vendor/bundle/ruby/2.2.0/bundler/gems/vagrant-dbb756c7b6da/website/source/docs/cli/login.html.md
vagrant-compose-yaml-0.1.1 vendor/bundle/ruby/2.2.0/bundler/gems/vagrant-dbb756c7b6da/website/source/docs/cli/login.html.md
vagrant-compose-yaml-0.1.0 vendor/bundle/ruby/2.2.0/bundler/gems/vagrant-dbb756c7b6da/website/source/docs/cli/login.html.md