Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Commit

Permalink
Make it very clear password should be used
Browse files Browse the repository at this point in the history
Add admonition that you should use your GitHub password when running
`rug login`.

Addresses part of #161.
  • Loading branch information
David Dooling committed May 1, 2017
1 parent 74c2cb1 commit 3841996
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/tutorials/cli-quick-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,23 @@ be sent to Atomist; only to api.github.com.
Successfully logged in to GitHub and stored token in ~/.atomist/cli.yml
```

The Rug CLI will authenticate against GitHub and create
a [personal access token][pat] with "read:org" scope and store it so
it can determine what GitHub orgs you are in when configuring your
repositories (see below).

!!! fail "Do not enter a personal access token"
GitHub requires that you authenticate with your password, not a
personal access token, when creating a personal access token so be
sure to provide your GitHub username and *password*.

If you have two-factor authentication configure on your GitHub account,
you will be prompted for your second factor code as `MFA code`.

!!! danger "Atomist does not store your GitHub credentials"

As the command output says, Atomist does not store your GitHub
credentials. They are used to authenticate against the GiTHub API
to create a properly scoped [personal access token][pat].
to create a properly scoped personal access token.

[pat]: https://github.com/settings/tokens (GitHub Personal Access Tokens)

Expand Down

0 comments on commit 3841996

Please sign in to comment.