Command Line Interface¶
For certain actions you can use the
sentry-cli command line
executable. It can connect to the Sentry API and manage some data for
your projects. Currently the tool is still very barebones and is
primarily used for managing debug symbols for the iOS integration as well
as basic release management.
Depending on your platform there are different methods available to install sentry-cli.
You can find the list of releases on the github release page. We provide
executables for Linux, OS X and Windows. It’s a single file download and
upon receiving the file you can rename it to just
sentry-cli.exe to use it.
If you are on OS X or Linux you can use the automated downloader which will fetch the latest release version for you and install it:
curl -sL https://sentry.io/get-cli/ | bash
This will automatically download the correct version of
your operating system and install it. If necessarily it will prompt for
your admin password for
To verify it’s installed correctly you can bring up the help:
$ sentry-cli --help
Installation via NPM¶
There is also the option to install sentry-cli via npm for specialized
use cases. This for instance is useful for build servers. The package is
sentry-cli-binary and in the post installation it will download
the appropriate release binary:
$ npm install sentry-cli-binary
You can then find it in the .bin folder:
$ ./node_modules/.bin/sentry-cli --help
Installation via Homebrew¶
If you are on OS X you can install sentry-cli via homebrew:
$ brew install getsentry/tools/sentry-cli
To sign the cli tool in you can use the login command which will guide you through it:
$ sentry-cli login
If you want to manually authenticate
sentry-cli you can to your to
your auth token settings in your user account (User Icon -> API) and
generate a new token. Afterwards you can export the
Alternatively you can provide the
--auth-token command line parameter
whenever you invoke sentry-cli or add it to your .sentryclirc config
The sentry-cli tool can be configured with a config file named
.sentryclirc as well as environment variables. The config file is
looked for upwards from the current path and defaults from
~/.sentryclirc are always loaded. You can also override these settings
from command line parameters.
The config file uses standard INI syntax.
The following settings are available (first is envvar, second is the config key in the config file):
- the authentication token to use for all communication with Sentry.
- the legacy API key for authentication if you have one.
- The URL to use to connect to sentry. This defaults to
- the slug of the organization to use for a command.
- the slug of the project to use for a command.
- This ini only setting is used to control the behavior of the SDK with regards to HTTP keepalives. The default is true but it can be set to false to disable keepalive support.
- The URL that should be used for the HTTP proxy. The standard
http_proxyenvironment variable is also honored. Note that it is lowercase.
- This ini only setting sets the proxy username in case proxy authentication is required.
- This ini only setting sets the proxy password in case proxy authentication is required.
- This can be used to disable SSL verification when set to false. You should never do that unless you are working with a known self signed server locally.
- If this is set to false then SSL revocation checks are disabled on Windows. This can be useful when working with a corporate SSL MITM proxy that does not properly implement revocation checks. Do not use this unless absolutely necessary.
- Configures the log level for the SDK. The default is
warning. If you want to see what the library is doing you can set it to
infowhich will spit out more information which might help to debug some issues with permissions.
Validating The Config¶
To make sure everything works you can run
sentry-cli info and it should
print out some basic information about the Sentry installation you connect
to as well as some authentication information.
Updating and Uninstalling¶
You can use
sentry-cli update and
sentry-cli uninstall to update
or uninstall the sentry command line interface. These commands might be
unavailable in certain situations (for instance if you install sentry-cli