From 839cda08c4bcd4375738ebffca940d9bec03a9a6 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Thu, 27 Feb 2014 15:05:42 -0800 Subject: [PATCH] website/docs: document vagrant login --- website/docs/source/layouts/layout.erb | 1 + website/docs/source/v2/cli/login.html.md | 30 ++++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 website/docs/source/v2/cli/login.html.md diff --git a/website/docs/source/layouts/layout.erb b/website/docs/source/layouts/layout.erb index ef784bbd2..3981156bb 100644 --- a/website/docs/source/layouts/layout.erb +++ b/website/docs/source/layouts/layout.erb @@ -110,6 +110,7 @@ >destroy >halt >init + >login >package >plugin >provision diff --git a/website/docs/source/v2/cli/login.html.md b/website/docs/source/v2/cli/login.html.md new file mode 100644 index 000000000..4daf29075 --- /dev/null +++ b/website/docs/source/v2/cli/login.html.md @@ -0,0 +1,30 @@ +--- +page_title: "vagrant login - Command-Line Interface" +sidebar_current: "cli-login" +--- + +# Login + +**Command: `vagrant login`** + +The login command is used to authenticate with a +[Vagrant Cloud](http://www.vagrantcloud.com) server. Logging is only +necessary if you're accessing protected boxes or using +[Vagrant Share](/v2/share/index.html). + +**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](/v2/share/index.html) require a login. + +The reference of available command-line flags to this command +is available below. + +## Options + +* `--check` - This will check if you're logged in. In addition to outputting + whether you're logged in or not, the command will have exit status 0 if you're + logged in, and exit status 1 if you're not. + +* `--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 + command if you're already logged out.