Getting Started

Install the Luciq CLI with RubyGems or Homebrew, generate an authentication token in your dashboard, and run your first command in minutes.

Get the Luciq CLI installed and authenticated in a couple of minutes.

1

Install the CLI

The CLI ships as a Ruby gem (Ruby 2.7 or later) and via Homebrew.

Using RubyGems

gem install luciq-cli

Using Homebrew (macOS/Linux)

brew install luciqai/tap/luciq-cli

From source

git clone https://github.com/Instabug/luciq-cli.git
cd luciq-cli
bundle install
bundle exec rake install

2

Generate an authentication token

1. Log in to your Luciq dashboard.
2. Click your profile avatar (top-right) and open Account Management.
3. Select Luciq CLI from the left sidebar, or go directly to dashboard.luciq.ai/company/luciq-cli.
4. Click Generate authentication token and copy the token.

Each user gets one CLI token, shown in full only once. The token is tied to your account, so every CLI command runs with your role's permissions. To rotate it, revoke the existing token and generate a new one.

Treat your CLI token like a password: don't commit it to source control or paste it into shared logs. Note that luciq info prints the configured token in plain text — avoid sharing its output.

3

Authenticate

Run luciq login and paste your token when prompted:

luciq login

Or pass the token directly:

luciq login --auth-token YOUR_CLI_TOKEN

Both store the token in ~/.luciqrc. Alternatively, skip login entirely and set an environment variable — useful for CI:

export LUCIQ_AUTH_TOKEN=YOUR_CLI_TOKEN

4

Verify and run your first command

luciq whoami calls the Luciq API with your token and prints the authenticated user:

luciq whoami
# Authenticated as:
#   Email: [email protected]
#   Name:  Your Name

Then list the applications you can access and pull your first data:

luciq apps list
luciq crashes list --slug my-app --mode production --limit 10

---

Configuration

The CLI reads its configuration from environment variables and the ~/.luciqrc file. Environment variables take precedence over the file.

Environment variables

Variable	Description
LUCIQ_AUTH_TOKEN	Authentication token
LUCIQ_URL	API base URL (default: https://api.luciq.ai)

Config file

~/.luciqrc is a plain key=value file. Lines starting with # are ignored.

# ~/.luciqrc
token=your-cli-token
url=https://api.luciq.ai

Self-hosted / single-tenant clusters

If your workspace runs on a dedicated cluster, point the CLI at your cluster's API host (note this is different from your dashboard host):

export LUCIQ_URL=https://api.your-cluster.luciq.ai

Or add url=https://api.your-cluster.luciq.ai to ~/.luciqrc. Generate your token from your cluster's dashboard (replace the dashboard host with your cluster's dashboard URL).

---

Utility commands

Command	Description
luciq whoami	Show the authenticated user (validates the token)
luciq info	Show CLI version, API URL, and configured token
luciq logout	Remove the saved token from ~/.luciqrc
luciq version	Show the CLI version

---

Next steps

• Uploading Symbol Files — wire symbol uploads into your release pipeline
• Command Reference — every data command with its options