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

Uploaded Python 3

File details

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

File metadata

  • Download URL: kctl_gsc-0.6.0.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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.6.0.tar.gz
Algorithm Hash digest
SHA256 d6a1266d8e7942810e81adec828948b85efb9f79a7153ec93d9cdf85d8961697
MD5 d9b56d99ff2f5302f14dc16c8de690cf
BLAKE2b-256 3038c8446282bb492f19d2f53a5cb2a2c5dc421bee06a36f330759232963541d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kctl_gsc-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e15d4282f510badf5b1f574ecae8cbea6a129d21a7524c0999b2a6b262b538d
MD5 584209190e57e1226f452f49dec504cf
BLAKE2b-256 9813a18142788d7b410ccf1707e357953a347d1ad0c4e86de22f9381a13a8968

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