gog auth setup
Generated from
gog schema --json. Do not edit this page by hand; runmake docs-commands.
Guide Google Cloud, OAuth client, and account setup
#Usage
gog auth setup [<email>] [flags]#Parent
#Flags
| Flag | Type | Default | Help |
|---|---|---|---|
--access-token | string | Use provided access token directly (bypasses stored refresh tokens; token expires in ~1h) | |
-a--account--acct | string | Account email, alias, or auto for authenticated Google API commands | |
--client | string | OAuth client name (selects stored credentials + token bucket) | |
--color | string | auto | Color output: auto|always|never |
--create-project | bool | Create --gcloud-project with gcloud (requires confirmation) | |
--credentials | string | Downloaded Desktop OAuth client JSON to store | |
--disable-commands | string | Comma-separated list of disabled commands; dot paths allowed | |
-n--dry-run--dryrun--noop--preview | bool | Do not make changes; print intended actions and exit successfully | |
--enable-apis | bool | Enable selected Google APIs with gcloud | |
--enable-commands | string | Comma-separated list of enabled command prefixes; dot paths allowed (restricts CLI) | |
--enable-commands-exact | string | Comma-separated list of exact enabled commands; dot paths allowed and parent commands do not enable children | |
-y--force--assume-yes--yes | bool | Skip confirmations for destructive commands | |
--force-consent | bool | Force OAuth consent when --login runs | |
--gcloud-project--project-id | string | Google Cloud project ID (default: active gcloud project) | |
--gmail-no-send | bool | false | Block Gmail send operations (agent safety) |
-h--help | kong.helpFlag | Show context-sensitive help. | |
--home | string | Override gogcli config/data/state/cache root (equivalent to GOG_HOME) | |
-j--json--machine | bool | false | Output JSON to stdout (best for scripting) |
--login | bool | Run browser OAuth after project/client setup | |
--no-input--non-interactive--noninteractive | bool | Never prompt; fail instead (useful for CI) | |
--open-console | bool | Open the OAuth client page for the selected project | |
-p--plain--tsv | bool | false | Output stable, parseable text to stdout (TSV; no colors) |
--project-name | string | gog CLI | Display name when creating a project |
--readonly | bool | false | Block mutating API requests at runtime; auth add also requests read-only OAuth scopes |
--results-only | bool | In JSON mode, emit only the primary result (drops envelope fields like nextPageToken) | |
--select--pick--project | string | In JSON mode, select comma-separated fields (best-effort; supports dot paths). Desire path: use --fields for most commands. | |
--services | string | gmail,calendar,drive,docs,sheets,contacts | Services to configure: comma-separated gmail,calendar,chat,classroom,drive,driveactivity,drivelabels,docs,slides,contacts,tasks,sheets,people,forms,sites,meet,appscript,analytics,searchconsole,ads,youtube,photos |
-v--verbose | bool | Enable verbose logging | |
--version | kong.VersionFlag | Print version and exit | |
--wrap-untrusted | bool | false | In JSON/raw output, wrap fetched text fields in external untrusted-content markers |