dannyota/splunkctl

** Работайте с Splunk Enterprise и Splunk SOAR в качестве кода с сервером CLI и MCP для людей и агентов ИИ.

Документация · Командный каталог · Выпуски

splunkctl является открытым исходным кодом Python CLI и Сервер Model Context Protocol (MCP) Удаленные экземпляры Splunk Enterprise и Splunk SOAR. Используйте его интерактивно, скрипт стабильного вывода JSON или предоставление клиенту MCP доступа к одной и той же команде поверхность.

Управление Splunk Enterprise — поиски, правила обнаружения, оповещения, индексы, входы, поиски, парсеры, панели инструментов, приложения, пользователи, топология, аудит и Рабочие процессы Enterprise Security. Operate Splunk SOAR — контейнеры, артефакты, игровые книжки, действия, кейсы, утверждения, активы, файлы хранилища, пользовательские списки, администрирование и SIEM-to-SOAR глотать. Сохраняйте конфигурацию в виде кода — тяните живое состояние, просматривайте структурированный дрейф, и продвигать утвержденные изменения с отчетами об изменениях. ** Автоматически безопасно** — предварительный просмотр мутаций по умолчанию, выход машины Структурированы, набираются ошибки, отображается каждый целевой профиль и хост.

Каждая мутация по умолчанию является сухой. Ничего не меняется, пока вы не пройдете [[Т1]]. Проанализируйте цель и предлагаемые изменения перед ее применением.

---

splunkctl is an open-source Python CLI and Model Context Protocol (MCP) server for remote Splunk Enterprise and Splunk SOAR instances. Use it interactively, script its stable JSON output, or give an MCP client access to the same command surface.

• Manage Splunk Enterprise — searches, detection rules, alerts, indexes, inputs, lookups, parsers, dashboards, apps, users, topology, audit, and Enterprise Security workflows.
• Operate Splunk SOAR — containers, artifacts, playbooks, actions, cases, approvals, assets, vault files, custom lists, administration, and SIEM-to-SOAR ingest.
• Keep configuration as code — pull live state, review structured drift, and push approved changes with change-evidence reports.
• Automate safely — mutations preview by default, machine output is structured, errors are typed, and every target profile and host is shown.

Every mutation is a dry run by default. Nothing changes until you pass --yes. Review the target and proposed change before applying it.

Install

python -m pip install splunkctl

Python 3.13 or newer is required. Core commands work with the upstream Splunk SDK installed from PyPI.

Dashboard, lookup-file, and HTTP Event Collector (HEC) token commands use entity classes provided by the optional splunkctl SDK fork:

python -m pip install git+https://github.com/dannyota/splunk-sdk-python@splunkctl

See the installation guide for environment-specific setup.

Quickstart

# Configure and verify Splunk Enterprise
splunkctl config init
splunkctl doctor

# Read live state
splunkctl info
splunkctl search run 'index=main | head 10'
splunkctl rules list --json

# Preview a change; add --yes only after reviewing it
splunkctl rules disable 'My Rule'

# Add and verify Splunk SOAR when needed
splunkctl config init --soar