Quick start
Sign in, pick a property, and run your first Google Search Console commands with gsc.
1. Log in
gsc auth loginYour browser opens Google's consent page. Approve access, and gsc saves the login in your OS keychain,
lists your properties, and picks a default site: your only property, or the one you choose from a list.
On a machine without a browser, use gsc auth login --no-browser; Authentication
covers service accounts and CI.
2. Check your properties
gsc sites list # properties and your permission level
gsc sites use sc-domain:example.com # change the default property
gsc auth status # the active credential and property; no network callProperties are either domain properties (sc-domain:example.com) or URL prefixes
(https://www.example.com/), exactly as sites list prints them. -s picks one for a single command,
and a bare host such as example.com is matched against your properties: a domain property wins,
otherwise a single URL-prefix match.
3. Read your performance
gsc freshness # the latest final and preliminary dates
gsc performance --last 28d --compare previous # totals, and the change from the 28 days before
gsc top queries --last 3m --limit 50
gsc trend --last 16m --by month4. Dig into the rows
gsc query -d query -d page --filter 'page =~ ^https://www.example.com/blog/' --limit 5000 -o csv > blog.csv
gsc insights striking-distance --last 28d5. Check pages and sitemaps
gsc inspect https://www.example.com/pricing
gsc sitemaps list
gsc sitemaps submit https://www.example.com/sitemap.xml --dry-run # see the request firstCommands use final data by default, and the last two or three days are usually still preliminary,
so --last 28d ends at the latest final day. gsc freshness shows where that is, and
Reading the data explains the rest.
Discovering commands
gsc --help
gsc query --help
gsc doctor # configuration, credentials, keychain, scopes, and PATHAuthentication
Sign in to gsc-cli with your browser, a headless flow, your own OAuth client, a service account, Application Default Credentials, or an access token.
Output formats
Table, JSON, YAML, and CSV output in gsc, the stdout and stderr contract, the Search Analytics envelope, and structured errors.