Skip to main content

Kodemeio Google Search Console CLI — properties, queries, indexing, reports

Project description

kctl-gsc

Kodemeio Google Search Console CLI — manage properties, search queries, URL indexing, and SEO reports.

Installation

uv tool install kctl-gsc

Requires kctl-lib>=0.4.0 and Google API client libraries (installed automatically).

Quick Start

# Configure a profile (service account credentials)
kctl-gsc config init

# List all GSC properties
kctl-gsc properties list

# Top queries for the last 28 days
kctl-gsc queries top --days 28

# Inspect a URL's index status
kctl-gsc inspect url https://example.com/page

# Generate an overview report
kctl-gsc reports overview

# Export raw search analytics to CSV
kctl-gsc export csv --output analytics.csv

Command Groups

Group Description Key Commands
properties GSC property browsing list, show
queries Search Analytics (query dimension) top, search, trends
pages Search Analytics by page top
sitemaps Sitemap management list, submit, delete
inspect URL Inspection API url, bulk, request-index
reports Opinionated SEO reports overview, product, opportunities, drift
export Raw data export csv, json
config Profile management init, add, use, show, validate, remove, set, profiles, current
doctor Diagnostic checks API connectivity, auth validation

Global Options

Option Short Description
--profile -p Config profile name
--property GSC property URI override
--credentials-file Service account JSON file override
--format -f Output format: pretty, json, csv, yaml
--json Shortcut for --format json
--quiet -q Suppress info messages
--no-header Omit headers in CSV output
--version -V Show version and exit

Configuration

Config lives in ~/.config/kodemeio/config.yaml under the gsc service key.

# Interactive setup
kctl-gsc config init

# Add a named profile
kctl-gsc config add --profile production \
  --property sc-domain:example.com \
  --credentials-file ~/sa-key.json

# Switch active profile
kctl-gsc config use production

# Show current config (secrets masked)
kctl-gsc config show

Development

cd packages/kctl-gsc
uv sync --all-extras
uv run pytest tests/ -v
uv run mypy src/
uv run ruff check src/
uv build

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kctl_gsc-0.3.0.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kctl_gsc-0.3.0-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file kctl_gsc-0.3.0.tar.gz.

File metadata

  • Download URL: kctl_gsc-0.3.0.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kctl_gsc-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e04a81b638241d7bf8137ea0c0e0cea0f6138ecb6a9de9dc95abd6ca4b75656b
MD5 03badb59d944859f4c0e3c25d0b4b33b
BLAKE2b-256 2e9ebe194f1a99fdd01fcff63ea6a6cff29aead46d5073ad994998b217899697

See more details on using hashes here.

File details

Details for the file kctl_gsc-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: kctl_gsc-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 22.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kctl_gsc-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 815a1a5e5a33e467ee5451d7285f5a78085508d49d07d5d40f080f47f327d1b5
MD5 64c8ea5c863ec452db9acdf86e64c28d
BLAKE2b-256 33c93d610fb8f209bdf67f4a935caa2a5313ddcbd0cf3eaeb096da0c62d59c31

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page