splunk-power-client 0.1.1

Splunk Power Client (SPC) is a Python module that provides spc command line to simplify the day-to-day tasks of Splunk users and administrators.

Splunk Power Client

A modern, scriptable command-line client for Splunk power users and administrators.

spc is a Python CLI that streamlines day-to-day Splunk operations — uploading lookups, managing saved searches, dispatching jobs, editing configurations — through a fast, scriptable, multi-instance command line.

📚 Documentation · 📝 Changelog · 🤝 Contributing

[!WARNING] 🚧 Work in progress — spc is still under active development. Expect breaking changes, rough edges, and bugs. Use it with caution in production environments — and please open an issue if you hit one.

---

Features

• Lookups — Upload from CSV, JSON, or Excel into Lookup CSV or KVStore. Synchronise a lookup from one Splunk instance to another in a single command.
• Saved searches — Reschedule in bulk, dispatch in the past with trigger actions (replay), or backfill over an arbitrary time window.
• Jobs — List, inspect, and manage search jobs.
• Configurations — Update Splunk configuration files quickly.
• Users — Create multiple local users from a definition file.
• Secrets — Manage Splunk secrets safely.
• Ingest — Stream events into Splunk programmatically.
• Multi-instance — Switch seamlessly between Splunk environments (dev / staging / prod) from a single profile-aware configuration.

Installation

# As a standalone tool
uv tool install splunk-power-client

# Or with pip
pip install splunk-power-client

Requires Python 3.13+.

Quickstart

# Discover commands
spc --help

# Manage instances (add / list / update / remove)
spc instances --help

# Show the active Splunk instance and its details
spc info

For the full command reference, examples, and recipes, see the documentation.

Commands

Command	Status	What it does
instances	✅	Add, list, and switch between Splunk instances
info	✅	Show details of the active Splunk instance
lookups	✅	Upload, synchronise, list, delete CSV / KVStore lookups
secrets	✅	Manage Splunk secrets
jobs	✅	List and inspect search jobs
debug/refresh	✅	Refresh Splunk configuration without restart
searches	🚧	Reschedule, dispatch, replay saved searches
configs	🚧	Bulk-update Splunk configuration files
users	🚧	Create multiple local users
ingest	🚧	Stream events into Splunk

Legend: ✅ available · 🚧 work in progress

Development

This project uses uv for everything — dependency management, building, publishing.

git clone https://github.com/nicolas-rdgs/Splunk-Power-Client.git
cd Splunk-Power-Client

uv sync --all-extras --dev
uv run pre-commit install
uv run pre-commit install --hook-type commit-msg

Common commands:

uv run ruff check .              # lint
uv run ruff format --check .     # format check
uv run pytest                    # tests
uv run mkdocs serve              # preview docs locally
uv build                         # build wheel + sdist

The full contribution flow — Conventional Commits, PR conventions, and the automated release pipeline — is documented in CONTRIBUTING.md.

Development methodology

The core architecture, feature design, and the bulk of spc are written by hand. AI assistance (Claude, by Anthropic) is used deliberately and under human review to accelerate well-defined, lower-creativity work and to drastically improve quality and reduce development time. Concretely, AI helps with:

• Refactoring and naming consistency
• Scaffolding repetitive code (model definitions, command boilerplate)
• Improving test coverage and edge-case handling
• Writing and polishing documentation
• Setting up and maintaining the CI/CD pipeline

Every change goes through a Pull Request and a human review before reaching main. Nothing is committed unreviewed.

Release process

Releases are fully automated. Merging a Pull Request with a Conventional Commits-formatted title to main triggers:

1. Test — ruff check, ruff format --check, pytest --cov
2. Version — python-semantic-release decides the next SemVer, updates pyproject.toml and CHANGELOG.md, tags vX.Y.Z
3. Build & publish — uv build, then uv publish --trusted-publishing always (OIDC, no long-lived tokens)
4. GitHub Release — with the changelog section and a Contributors list

See CONTRIBUTING.md for the human side of this flow.

Acknowledgements

Built on Splunk Enterprise SDK for Python, Typer, Pydantic, Rich, and uv.

License

Released under the MIT License — © 2025 Nicolas Rodrigues.