splunkctl 0.1.0__tar.gz

splunkctl-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 dannyota
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

splunkctl-0.1.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: splunkctl
+Version: 0.1.0
+Summary: CLI tool for Splunk Enterprise SIEM operations.
+Author: dannyota
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/dannyota/splunkctl
+Project-URL: Repository, https://github.com/dannyota/splunkctl
+Project-URL: Issues, https://github.com/dannyota/splunkctl/issues
+Keywords: splunk,siem,security,cli,detection,spl
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: splunk-sdk>=2.1.0
+Requires-Dist: click>=8.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: tabulate>=0.9
+Dynamic: license-file
+
+# splunkctl
+
+CLI tool for Splunk Enterprise SIEM operations.
+
+Query, inspect, and manage a Splunk Enterprise instance from the terminal.
+Built on the [splunk-sdk-python](https://github.com/dannyota/splunk-sdk-python)
+fork with [Click](https://click.palletsprojects.com/).
+
+## Install
+
+```bash
+pip install splunkctl
+```
+
+Requires Python 3.13+.
+
+## Quick start
+
+```bash
+splunkctl config init                         # interactive setup
+splunkctl config test                         # verify connectivity
+splunkctl search run 'index=main | head 10'   # run a search
+splunkctl rules list                          # list detection rules
+splunkctl dashboards list                     # list dashboards
+```
+
+## Commands
+
+| Group | Description |
+|---|---|
+| `config` | Setup, show config, test connectivity |
+| `info` | Server info (version, OS, license) |
+| `search` | Run, export, oneshot, job management |
+| `rules` | Detection rules (saved searches) — full CRUD |
+| `alerts` | Fired alerts, alert actions, suppression |
+| `dashboards` | Dashboard CRUD (XML) |
+| `indexes` | Index management |
+| `inputs` | Data inputs (monitor, tcp, udp, script, http) |
+| `lookups` | Lookup table CRUD (CSV) |
+| `parsers` | Source types and field extractions |
+| `apps` | App install, uninstall, update |
+| `users` | User and role management |
+| `commands` | Machine-readable command tree (JSON) |
+| `skill` | Embedded agent operating guide |
+
+## Global flags
+
+```
+--json              Force JSON output
+--format FMT        Output format: table, json, csv, jsonl
+--fields f1,f2      Project specific fields
+--out FILE          Write output to file
+--yes / -y          Apply mutations (skip dry-run preview)
+--timeout N         Request timeout in seconds (default 30)
+--config FILE       Config file path
+--debug             HTTP request/response logging
+```
+
+## Dry-run by default
+
+All write operations preview what would change. Pass `--yes` to apply.
+
+```bash
+splunkctl rules delete 'My Rule'          # shows preview only
+splunkctl rules delete 'My Rule' --yes    # actually deletes
+```
+
+## Output formats
+
+```bash
+splunkctl rules list                      # table (TTY) or JSON (pipe)
+splunkctl rules list --json               # force JSON
+splunkctl rules list --format csv         # CSV
+splunkctl rules list --fields name,cron   # project fields
+splunkctl rules list --out rules.json     # write to file
+```
+
+## Agent integration
+
+splunkctl ships with an embedded operating guide for AI agents
+(Claude Code, etc.):
+
+```bash
+splunkctl skill                           # print the guide
+splunkctl skill install                   # install to ~/.claude/skills/
+splunkctl commands                        # JSON command tree for discovery
+```
+
+## License
+
+Apache-2.0

splunkctl-0.1.0/README.md

@@ -0,0 +1,91 @@
+# splunkctl
+
+CLI tool for Splunk Enterprise SIEM operations.
+
+Query, inspect, and manage a Splunk Enterprise instance from the terminal.
+Built on the [splunk-sdk-python](https://github.com/dannyota/splunk-sdk-python)
+fork with [Click](https://click.palletsprojects.com/).
+
+## Install
+
+```bash
+pip install splunkctl
+```
+
+Requires Python 3.13+.
+
+## Quick start
+
+```bash
+splunkctl config init                         # interactive setup
+splunkctl config test                         # verify connectivity
+splunkctl search run 'index=main | head 10'   # run a search
+splunkctl rules list                          # list detection rules
+splunkctl dashboards list                     # list dashboards
+```
+
+## Commands
+
+| Group | Description |
+|---|---|
+| `config` | Setup, show config, test connectivity |
+| `info` | Server info (version, OS, license) |
+| `search` | Run, export, oneshot, job management |
+| `rules` | Detection rules (saved searches) — full CRUD |
+| `alerts` | Fired alerts, alert actions, suppression |
+| `dashboards` | Dashboard CRUD (XML) |
+| `indexes` | Index management |
+| `inputs` | Data inputs (monitor, tcp, udp, script, http) |
+| `lookups` | Lookup table CRUD (CSV) |
+| `parsers` | Source types and field extractions |
+| `apps` | App install, uninstall, update |
+| `users` | User and role management |
+| `commands` | Machine-readable command tree (JSON) |
+| `skill` | Embedded agent operating guide |
+
+## Global flags
+
+```
+--json              Force JSON output
+--format FMT        Output format: table, json, csv, jsonl
+--fields f1,f2      Project specific fields
+--out FILE          Write output to file
+--yes / -y          Apply mutations (skip dry-run preview)
+--timeout N         Request timeout in seconds (default 30)
+--config FILE       Config file path
+--debug             HTTP request/response logging
+```
+
+## Dry-run by default
+
+All write operations preview what would change. Pass `--yes` to apply.
+
+```bash
+splunkctl rules delete 'My Rule'          # shows preview only
+splunkctl rules delete 'My Rule' --yes    # actually deletes
+```
+
+## Output formats
+
+```bash
+splunkctl rules list                      # table (TTY) or JSON (pipe)
+splunkctl rules list --json               # force JSON
+splunkctl rules list --format csv         # CSV
+splunkctl rules list --fields name,cron   # project fields
+splunkctl rules list --out rules.json     # write to file
+```
+
+## Agent integration
+
+splunkctl ships with an embedded operating guide for AI agents
+(Claude Code, etc.):
+
+```bash
+splunkctl skill                           # print the guide
+splunkctl skill install                   # install to ~/.claude/skills/
+splunkctl commands                        # JSON command tree for discovery
+```
+
+## License
+
+Apache-2.0

splunkctl-0.1.0/pyproject.toml

@@ -0,0 +1,96 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "splunkctl"
+dynamic = ["version"]
+description = "CLI tool for Splunk Enterprise SIEM operations."
+readme = "README.md"
+requires-python = ">=3.13"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "dannyota" }]
+keywords = ["splunk", "siem", "security", "cli", "detection", "spl"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Security",
+    "Topic :: System :: Systems Administration",
+]
+dependencies = [
+    "splunk-sdk>=2.1.0",
+    "click>=8.0",
+    "pyyaml>=6.0",
+    "tabulate>=0.9",
+]
+
+[project.scripts]
+splunkctl = "splunkctl.main:cli"
+
+[project.urls]
+Homepage = "https://github.com/dannyota/splunkctl"
+Repository = "https://github.com/dannyota/splunkctl"
+Issues = "https://github.com/dannyota/splunkctl/issues"
+
+[tool.setuptools]
+packages = ["splunkctl", "splunkctl.commands", "splunkctl.skill"]
+
+[tool.setuptools.dynamic]
+version = { attr = "splunkctl.__version__" }
+
+[tool.setuptools.package-data]
+"splunkctl.skill" = ["SKILL.md"]
+
+# --- Ruff (lint + format) ---
+
+[tool.ruff]
+line-length = 88
+target-version = "py313"
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "D",   # pydocstyle
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+    "S",   # flake8-bandit (security)
+]
+ignore = [
+    "D100", # missing module docstring
+    "D104", # missing public package docstring
+    "D203", # conflicts with D211
+    "D213", # conflicts with D212
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["S101", "S105", "D"]
+
+# --- mypy (strict) ---
+
+[tool.mypy]
+python_version = "3.13"
+strict = true
+disallow_untyped_defs = true
+warn_return_any = true
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+module = "splunklib.*"
+ignore_missing_imports = true
+
+# --- pytest ---
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--tb=short -q"

splunkctl-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

splunkctl-0.1.0/splunkctl/__init__.py

@@ -0,0 +1,3 @@
+"""CLI tool for Splunk Enterprise SIEM operations."""
+
+__version__ = "0.1.0"

splunkctl-0.1.0/splunkctl/__main__.py

@@ -0,0 +1,5 @@
+"""Allow running as `python -m splunkctl`."""
+
+from splunkctl.main import cli
+
+cli()

splunkctl-0.1.0/splunkctl/client.py

@@ -0,0 +1,103 @@
+"""SDK wrapper — lazy connection and auth resolution."""
+
+from pathlib import Path
+from typing import Any
+
+import click
+import splunklib.client as splunk_client
+
+from splunkctl import config as cfg_mod
+
+
+class SplunkClient:
+    """Lazy-initializing Splunk SDK client.
+
+    Connection is established on first access to ``.service``.
+    Help, config, and offline commands never trigger auth.
+    """
+
+    def __init__(  # noqa: D107
+        self,
+        *,
+        config_path: Path | None = None,
+        host: str | None = None,
+        port: int | None = None,
+        username: str | None = None,
+        password: str | None = None,
+        token: str | None = None,
+        scheme: str | None = None,
+        app: str | None = None,
+        owner: str | None = None,
+        verify: bool | None = None,
+        timeout: int = 30,
+        debug: bool = False,
+    ) -> None:
+        self._config_path = config_path
+        self._overrides: dict[str, Any] = {
+            k: v
+            for k, v in {
+                "host": host,
+                "port": port,
+                "username": username,
+                "password": password,
+                "token": token,
+                "scheme": scheme,
+                "app": app,
+                "owner": owner,
+                "verify": verify,
+            }.items()
+            if v is not None
+        }
+        self._timeout = timeout
+        self._debug = debug
+        self._service: Any = None
+
+    @property
+    def service(self) -> Any:
+        """Connect on first access."""
+        if self._service is None:
+            if self._debug:
+                import logging
+
+                logging.basicConfig(level=logging.DEBUG)
+                logging.getLogger("splunklib").setLevel(logging.DEBUG)
+
+            cfg = cfg_mod.load(self._config_path)
+            cfg.update(self._overrides)
+
+            connect_args: dict[str, Any] = {
+                "host": cfg.get("host", "localhost"),
+                "port": int(cfg.get("port", 8089)),
+                "scheme": cfg.get("scheme", "https"),
+            }
+
+            if cfg.get("token"):
+                connect_args["splunkToken"] = cfg["token"]
+            else:
+                connect_args["username"] = cfg.get("username", "")
+                connect_args["password"] = cfg.get("password", "")
+
+            if cfg.get("app"):
+                connect_args["app"] = cfg["app"]
+            if cfg.get("owner"):
+                connect_args["owner"] = cfg["owner"]
+
+            if not cfg.get("verify", False):
+                connect_args["verify"] = False
+
+            if self._timeout:
+                connect_args["timeout"] = self._timeout
+
+            self._service = splunk_client.connect(**connect_args)
+
+        return self._service
+
+
+def get_client(ctx: click.Context) -> SplunkClient:
+    """Build a SplunkClient from Click context. Does not connect."""
+    obj: dict[str, Any] = ctx.ensure_object(dict)
+    return SplunkClient(
+        config_path=Path(obj["config"]) if obj.get("config") else None,
+        timeout=obj.get("timeout", 30),
+        debug=obj.get("debug", False),
+    )