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.

Installation

At present sentry-cli is only supported on OS X and Linux. It can be installed from a terminal with the following command:

curl -sL https://sentry.io/get-cli/ | bash

This will automatically download the correct version of sentry-cli for your operating system and install it. If necessarily it will prompt for your admin password for sudo.

To verify it’s installed correctly you can bring up the help:

$ sentry-cli --help

To sign the cli tool in you can use the login command which will guide you through it:

$ sentry-cli login

Configuration

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):

SENTRY_AUTH_TOKEN (auth.token):
the authentication token to use for all communication with Sentry.
SENTRY_API_KEY (auth.api_key):
the legacy API key for authentication if you have one.
SENTRY_URL (defaults.url):
The URL to use to connect to sentry. This defaults to https://sentry.io/.
SENTRY_ORG (defaults.org):
the slug of the organization to use for a command.
SENTRY_PROJECT (defaults.project):
the slug of the project to use for a command.
(http.keepalive):
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.
http_proxy (http.proxy_url):
The URL that should be used for the HTTP proxy. The standard http_proxy environment variable is also honored. Note that it is lowercase.
(http.proxy_username):
This ini only setting sets the proxy username in case proxy authentication is required.
(http.proxy_password):
This ini only setting sets the proxy password in case proxy authentication is required.
SENTRY_LOG_LEVEL (log.level):
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 info which will spit out more information which might help to debug some issues with permissions.

Authentication

To 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 SENTRY_AUTH_TOKEN environment variable:

export SENTRY_AUTH_TOKEN=your-auth-token

Alternatively you can provide the --auth-token command line parameter whenever you invoke sentry-cli or add it to your .sentryclirc config file.

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.