gsc-indexer docs: start here

Welcome to the gsc-indexer documentation. This page points you to every guide. If you're not sure where to begin, follow the learning path below.

What is gsc-indexer?

A command-line tool that asks Google to crawl / re-index your URLs via the Google Search Console URL Inspection API. one URL or ten thousand. Full explanation: What is gsc-indexer?.

Choose your path

I've never used this kind of tool. Start at the top and go in order. the setup steps are where most people get stuck:

1. Create and verify a GSC property
2. Create a service account and grant it access ⭐
3. Install, build, and run your first inspection

I'm set up and just want to use it.

• Understanding your results
• Batch files, stdin, and sitemaps
• Track indexed-vs-not over time

I have a big site or want to automate.

• Big runs without throttling
• Automating in CI

Something broke.

• Troubleshooting: 403, 401, and other errors
• FAQ

Full guide list (in order)

#	Guide
1	What is gsc-indexer?
2	Create and verify a GSC property
3	Service account + property access
4	Install, build, first run
5	Understanding results
6	Batch, stdin, sitemaps
7	Track indexed over time
8	Big runs without throttling
9	Automating in CI
10	Troubleshooting
.	FAQ

Quick command cheat sheet

## first inspection
./gsc-indexer -creds sa.json "https://www.toolsura.com/"

## many URLs from a file
./gsc-indexer -creds sa.json -batch urls.txt

## whole site via sitemap (preview first!)
./gsc-indexer -creds sa.json "https://www.toolsura.com/sitemap.xml" -dry-run
./gsc-indexer -creds sa.json "https://www.toolsura.com/sitemap.xml" -delay 10s -q -report ./report

## compare against last run
./gsc-indexer -creds sa.json -batch urls.txt -diff ./report/summary.json

Source code and the latest flags reference live in the GitHub repository.

Sources

• Google Search Console
• URL Inspection API documentation
• Google Search APIs overview
• Service account OAuth (Google Identity)
• About service accounts (Google Cloud IAM)
• Verify site ownership
• Property types: URL-prefix vs Domain
• URL Inspection tool help
• Indexing API (JobPosting/BroadcastEvent only)
• Request indexing / inspect a URL