About the CLI
You can use the Splunk platform command line interface (CLI) to monitor, configure, and execute searches. The CLI help exists in the product and is accessible through a terminal or shell interface. This topic discusses how to access this information.
Access the CLI
The Splunk platform CLI commands are located in
%SPLUNK_HOME%\bin on Windows hosts.)
You can find the Splunk installation path on your instance through Splunk Web by clicking Settings > Server settings > General settings.
To access the Splunk platform CLI, you need:
- A shell prompt, command prompt, or PowerShell session
- Access to a Splunk platform instance or forwarder, or
- Permission to access the correct port on a remote Splunk platform instance.
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 instance or instances. The CLI commands used for configuring and monitoring Splunk are not search commands. Search commands are arguments to the
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:
Work with the CLI on *nix
If you have administrator or root privileges, you can simplify CLI access by adding the top level directory of your Splunk platform installation,
$SPLUNK_HOME/bin, to your shell path.
This example works for Linux/BSD/Solaris users who installed Splunk Enterprise in the default location:
# export SPLUNK_HOME=/opt/splunk # export PATH=$SPLUNK_HOME/bin:$PATH
This example works for Mac users who installed Splunk Enterprise in the default location:
# export SPLUNK_HOME=/Applications/Splunk # export PATH=$SPLUNK_HOME/bin:$PATH
Now you can invoke CLI commands using:
To set the
$SPLUNK_HOME environment variable while working in a CLI session:
- In *nix:
- In Windows:
splunk.exe envvars > setSplunkEnv.bat & setSplunkEnv.bat
Mac OS X requires elevated privileges to access system files or directories
Mac OS X requires 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.)
Work with the CLI on Windows
To run CLI commands in Splunk Enterprise on Windows, use PowerShell or the command prompt as an administrator.
- Open a PowerShell window or command prompt as an administrator.
- Change to the Splunk Enterprise
- Run a Splunk command by typing in
splunkfollowed by the subcommand and any required arguments.
C:\Program Files\Splunk\bin> splunk status splunkd is running. splunk helpers are running.
You can run many commands and perform many tasks from the CLI. For help on using the CLI, see Get help with the CLI.
Set Splunk environment variables on Windows
You do not need to set Splunk environment variables to use the CLI on Windows. If you want to use environment variables to run CLI commands, you must set the variables manually, because Windows does not set the variables by default.
Set Splunk environment variables temporarily
- Open a PowerShell window or command prompt.
- Enter the following command from within either the PowerShell window or command prompt to set environment variables temporarily, or use the Environment Variables dialog box in Computer Properties to set the variables permanently.
PowerShell Command prompt
set SPLUNK_HOME="C:\Program Files\Splunk"
- Use the variable to run Splunk commands.
PowerShell Command prompt
%SPLUNK_HOME%\bin\splunk add forward-server 192.168.1.100:9997 -auth admin:<password>
Set Splunk environment variables permanently
After you complete this procedure, Windows uses the values you set for the variables until you either change or delete the variable entries.
To set environment variables permanently, see Add or change environment variables on MS TechNet.
Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has around using the CLI.
Check the integrity of your Splunk software files
Get help with the CLI
This documentation applies to the following versions of Splunk® Enterprise: 7.1.0, 7.1.1