agentleFS
Sign inStart free
abdullahkhawerabdullahkhawer/devops-skills/skills/splunk-cli/SKILL.md

splunk-cli

Skill8 starsChanged 6 months agoApache-2.0View on GitHub

Perform Splunk operations using the Splunk REST API via curl. Use for running search queries, and inspecting saved searches, indexes, and alerts.

We split this skill into the rules it gives an agent

9 rules. About 0 are common, 7 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use the instance and rules below when constructing all Splunk API commands.

    line 8
  2. Distinctive:

    Update the table below with your Splunk instance URLs and credential file paths:

    line 12
  3. Distinctive:

    If the target instance is unclear, ask the user before running any command.

    line 19
  4. Distinctive:

    NEVER target any Splunk instance not listed in the instance table above.

    line 75
  5. Distinctive:

    NEVER print, display, log, or store the contents of any token file.

    line 76
  6. Very specific:

    Always read the token inline with $(cat <TOKEN_FILE>) — never hardcode a token value in a command.

    line 77
  7. Very specific:

    Always pass -s (silent) to curl, use output_mode=json, and pipe through jq for readable output.

    line 78
  8. Distinctive:

    NEVER run DELETE endpoints or index-clean operations without explicit user instruction — these are irreversible.

    line 79
  9. Distinctive:

    If a saved search name or index name is unfamiliar, look it up with a read-only call first.

    line 81

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Splunk CLI Skill

Use the instance and rules below when constructing all Splunk API commands.

Instances

Update the table below with your Splunk instance URLs and credential file paths:

EnvironmentBase URLToken File
Productionhttps://<your-splunk-prod-url>:8089~/.splunk/prod.token
Staginghttps://<your-splunk-staging-url>:8089~/.splunk/staging.token

If the target instance is unclear, ask the user before running any command.

Prerequisites (one-time setup by user)

Generate a Splunk authentication token (Settings → Tokens) for each instance and save it to the corresponding token file. Never print or display token values. Do not perform these steps yourself.

mkdir -p ~/.splunk && echo "<your-auth-token>" > <TOKEN_FILE> && chmod 600 <TOKEN_FILE>

Command Format

curl -s -H "Authorization: Bearer $(cat <TOKEN_FILE>)" \
  "<BASE_URL>/services/<endpoint>?output_mode=json" | jq .

Available API Endpoints

Read-only (safe, no confirmation needed)

EndpointMethodDescription
/services/search/jobs/exportGET/POSTRun a search query and stream results
/services/search/jobs/<sid>/resultsGETGet results of a completed search job
/services/saved/searchesGETList saved searches
/services/data/indexesGETList indexes
/services/alerts/fired_alertsGETList fired alerts
/services/server/infoGETShow server/instance info

Example — run a search

curl -s -H "Authorization: Bearer $(cat <TOKEN_FILE>)" \
  --data-urlencode "search=search index=<index> error | head 20" \
  "<BASE_URL>/services/search/jobs/export?output_mode=json" | jq .

Mutating operations (confirm with user before running)

EndpointMethodDescription
/services/saved/searchesPOSTCreate a saved search
/services/saved/searches/<name>POSTUpdate a saved search
/services/data/indexesPOSTCreate a new index

Never run — requires explicit human approval

EndpointMethodReason
/services/saved/searches/<name>DELETEIrreversible deletion of a saved search
/services/data/indexes/<name>DELETEIrreversibly deletes an index and its data
/services/data/indexes/<name>POST (with clean action)Irreversibly clears all data from an index

Rules

  • NEVER target any Splunk instance not listed in the instance table above. If a URL references a different host, stop and ask the user to confirm.
  • NEVER print, display, log, or store the contents of any token file.
  • Always read the token inline with $(cat <TOKEN_FILE>) — never hardcode a token value in a command.
  • Always pass -s (silent) to curl, use output_mode=json, and pipe through jq for readable output.
  • NEVER run DELETE endpoints or index-clean operations without explicit user instruction — these are irreversible.
  • For search queries, always set a reasonable time range and head/| head N limit — an unbounded search over a large index can be slow and return excessive data.
  • If a saved search name or index name is unfamiliar, look it up with a read-only call first.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free