Splunk® Enterprise

Admin Manual

Download manual as PDF

About the CLI

You can use the Splunk Enterprise command line interface (CLI) to monitor, configure, and execute searches on your Splunk server. The CLI help exists in the product and is accessible through a terminal or shell interface. This topic discusses how to access this information and what commands are available.

How to access the CLI

The CLI is located in $SPLUNK_HOME/bin/splunk.

To access Splunk CLI, you need either:

  • Shell access to a Splunk server, or
  • Permission to access the correct port on a remote Splunk server.

If you have administrator or root privileges, you can simplify CLI access by adding the top level directory of your Splunk installation, $SPLUNK_HOME/bin , to your shell path.

This example works for Linux/BSD/Solaris users who installed Splunk in the default location:

# export SPLUNK_HOME=/opt/splunk
# export PATH=$SPLUNK_HOME/bin:$PATH

This example works for Mac users who installed splunk in the default location:

# export SPLUNK_HOME=/Applications/Splunk
# export PATH=$SPLUNK_HOME/bin:$PATH

Now you can invoke CLI commands using:

./splunk <command>

To set the $SPLUNK_HOME environment variable while working in a CLI session:

  • In *nix: source /opt/splunk/bin/setSplunkEnv
  • In Windows: splunk.exe envvars > setSplunkEnv.bat & setSplunkEnv.bat

CLI help documentation

If you have administrator privileges, you can use the CLI not only to search but also to configure and monitor your Splunk server (or servers). The CLI commands used for configuring and monitoring Splunk are not search commands. Search commands are arguments to the search and dispatch CLI commands. Some commands require you to authenticate with a username and password or specify a target Splunk server.

You can look up help information for the CLI using:

./splunk help

For more information about how to access help for specific CLI commands or tasks, see "Get help with the CLI" and "Administrative CLI commands" in this manual.

Note for Mac users

Mac OS X requires you to have superuser level access to run any command that accesses system files or directories. Run CLI commands using sudo or "su -" for a new shell as root. The recommended method is to use sudo. (By default the user "root" is not enabled but any administrator user can use sudo.)

Working with the CLI on Windows

To access and use CLI commands on Windows, run cmd.exe as administrator first. Also, If you're using Windows, Splunk does not require the "./" to run CLI commands.


Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has around using the CLI.

Back up configuration information
Get help with the CLI

This documentation applies to the following versions of Splunk: 4.1, 4.1.1, 4.1.2, 4.1.3, 4.1.4, 4.1.5, 4.1.6, 4.1.7, 4.1.8, 4.2, 4.2.1, 4.2.2, 4.2.3, 4.2.4, 4.2.5, 4.3, 4.3.1, 4.3.2, 4.3.3, 4.3.4, 4.3.5, 4.3.6, 4.3.7, 5.0, 5.0.1, 5.0.2, 5.0.3, 5.0.4, 5.0.5, 5.0.6, 5.0.7, 5.0.8, 5.0.9, 5.0.10, 5.0.11, 5.0.12, 5.0.13, 5.0.14, 6.0, 6.0.1, 6.0.2, 6.0.3, 6.0.4, 6.0.5, 6.0.6, 6.0.7, 6.0.8, 6.0.9, 6.0.10, 6.1, 6.1.1, 6.1.2, 6.1.3, 6.1.4, 6.1.5, 6.1.6, 6.1.7, 6.1.8, 6.1.9, 6.2.0, 6.2.1, 6.2.2, 6.2.3, 6.2.4, 6.2.5, 6.2.6, 6.2.7, 6.3.0, 6.3.1 View the Article History for its revisions.


http://docs.splunk.com/Documentation/Splunk/5.0.2/Admin/AbouttheCLI#How_to_access_the_CLI<br />^ that talks about setting up the "$PATH" then goes on to say "./splunk"<br /><br />It should probably instead say to "hash -r" then invoke as "splunk"

March 21, 2013

Logan, i recommend you try the User Manual to get some ideas:<br />http://www.splunk.com/base/Documentation/latest/User/<br /><br />tell Splunk to index some data, and then run a search for * in the Search app to see the events

August 23, 2010

How do you use splunk? So far all the technical docs just tell you what you can do. I would like to know how to check that what I have configured actually works. a step by step guide with basic examples would be nice.

August 20, 2010

Was this documentation topic helpful?

If you'd like to hear back from us, please provide your email address:

We'd love to hear what you think about this topic or the documentation as a whole
Feedback you enter here will be delivered to the documentation team

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters