> For the complete documentation index, see [llms.txt](https://docs.luciq.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.luciq.ai/product-guides-and-integrations/product-guides/luciq-cli/getting-started.md).

# Getting Started

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

{% stepper %}
{% step %}

#### Install the CLI

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

**Using RubyGems**

```bash
gem install luciq-cli
```

**Using Homebrew (macOS/Linux)**

```bash
brew install luciqai/tap/luciq-cli
```

**From source**

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

{% endstep %}

{% step %}

#### Generate an authentication token

1. Log in to your [Luciq dashboard](https://dashboard.luciq.ai).
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](https://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.

{% hint style="warning" %}
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.
{% endhint %}
{% endstep %}

{% step %}

#### Authenticate

Run `luciq login` and paste your token when prompted:

```bash
luciq login
```

Or pass the token directly:

```bash
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:

```bash
export LUCIQ_AUTH_TOKEN=YOUR_CLI_TOKEN
```

{% endstep %}

{% step %}

#### Verify and run your first command

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

```bash
luciq whoami
# Authenticated as:
#   Email: you@example.com
#   Name:  Your Name
```

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

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

{% endstep %}
{% endstepper %}

***

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

```bash
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**](/product-guides-and-integrations/product-guides/luciq-cli/uploading-symbol-files.md) — wire symbol uploads into your release pipeline
* [**Command Reference**](/product-guides-and-integrations/product-guides/luciq-cli/command-reference.md) — every data command with its options


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.luciq.ai/product-guides-and-integrations/product-guides/luciq-cli/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.