haskal
/
vagrant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update login docs

This commit is contained in:
Seth Vargo 2015-01-08 17:25:38 -05:00
parent ebdb694575
commit 2ebd076817
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
website/docs/source/v2/cli/login.html.md
View File

@ -19,6 +19,7 @@ boxes or [Vagrant Share](/v2/share/index.html) require a login.
The reference of available command-line flags to this command The reference of available command-line flags to this command
is available below. is available below.
## Options ## Options
* `--check` - This will check if you're logged in. In addition to outputting * `--check` - This will check if you're logged in. In addition to outputting
@ -28,3 +29,32 @@ is available below.
* `--logout` - This will log you out if you're logged in. If you're already * `--logout` - This will log you out if you're logged in. If you're already
logged out, this command will do nothing. It is not an error to call this logged out, this command will do nothing. It is not an error to call this
command if you're already logged out. command if you're 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.
```