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.5.2.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.5.2-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kctl_gsc-0.5.2.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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.5.2.tar.gz
Algorithm Hash digest
SHA256 77b0e6c769a36ea7be4f9a2381d589eda8c13be09cae0f3c032087c3d8e831e2
MD5 75bdacf3a7832f2290ec77f63482db9f
BLAKE2b-256 efcdffb762e06ce38c06b0e2fcad244a147425eaec40642237a6ed5d8a90481f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kctl_gsc-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 434554404265fd47d28a9390d2ba8218bdec0ca3158325f76ffaf17f7e8e8dbe
MD5 7d0e8e40e42f5b55ccb0c7df1a112fcd
BLAKE2b-256 78b5bb618db8fa2c73824d14aad87f2cb627795d4e43330c346594d3355bdbf6

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