gh-auth-login - Man Page

Authenticate with a GitHub host

Synopsis

gh auth login [flags]

Description

Authenticate with a GitHub host.

The default authentication mode is a web-based browser flow.

Alternatively, pass in a token on standard input by using --with-token. The minimum required scopes for the token are: "repo", "read:org".

The --scopes flag accepts a comma separated list of scopes you want your gh credentials to have. If absent, this command ensures that gh has access to a minimum set of scopes.

Options

-h,  --hostname <string>

The hostname of the GitHub instance to authenticate with

-s,  --scopes <strings>

Additional authentication scopes for gh to have

-w,  --web

Open a browser to authenticate

--with-token

Read token from standard input

Example

# start interactive setup
$ gh auth login

# authenticate against github.com by reading the token from a file
$ gh auth login --with-token < mytoken.txt

# authenticate with a specific GitHub Enterprise Server instance
$ gh auth login --hostname enterprise.internal

See Also

gh-auth(1)

Referenced By

gh-auth(1).

Jan 2022 GitHub CLI manual