> 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/command-reference.md).

# Command Reference

This page covers the CLI's data commands: querying and managing your Luciq apps from the terminal. For symbol uploads, see [Uploading Symbol Files](/product-guides-and-integrations/product-guides/luciq-cli/uploading-symbol-files.md).

All data commands require authentication with your CLI token (see [Getting Started](/product-guides-and-integrations/product-guides/luciq-cli/getting-started.md)). Under the hood, each command runs the same tool that powers the [Luciq MCP Server](/product-guides-and-integrations/product-guides/ai-features/luciq-mcp-server.md), so results, permissions, and behavior match what your AI assistant sees through MCP.

### Commands at a Glance

| Group                 | Subcommands                                                                                         | What they cover                                |
| --------------------- | --------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| `luciq apps`          | `list`                                                                                              | Applications you can access                    |
| `luciq crashes`       | `list`, `show`, `patterns`, `diagnostics`, `hangs`, `occurrence-tokens`, `occurrence`               | Crashes, ANRs, OOMs, non-fatals, and app hangs |
| `luciq bugs`          | `list`, `show`, `update`                                                                            | User-reported bugs and triage                  |
| `luciq apm`           | `groups`, `group`, `occurrence`, `funnel-events`, `funnel-create`, `funnel-update`, `funnel-delete` | Performance metrics and funnels                |
| `luciq reviews`       | `list`                                                                                              | App store reviews and ratings                  |
| `luciq surveys`       | `list`, `show`                                                                                      | Surveys and their responses                    |
| `luciq insights`      | —                                                                                                   | Aggregated app-health snapshot                 |
| `luciq issues`        | `list`                                                                                              | Unified issues ranked by impact                |
| `luciq opportunities` | `list`, `show`                                                                                      | Prioritized product opportunities              |
| `luciq alerts`        | `list`, `show`, `init`, `create`, `update`, `delete`                                                | Alert rules                                    |
| `luciq incidents`     | `list`, `show`, `resolve`, `reopen`                                                                 | Triggered alerts                               |

***

## Shared options

Most data commands target one application in one environment and share these options:

| Option                     | Description                                                                                          |
| -------------------------- | ---------------------------------------------------------------------------------------------------- |
| `--slug`                   | Application slug (required)                                                                          |
| `--mode`                   | Environment: `production`, `beta`, `staging`, `alpha`, `qa`, or `development` (required)             |
| `--offset`, `--limit`      | Pagination                                                                                           |
| `--sort-by`, `--direction` | Sort field and direction (`asc`/`desc`). Some commands use `--sort-direction` instead — check `help` |
| `--filters`                | Raw filter JSON object, merged with the typed filter flags                                           |

Common filters have dedicated typed flags (`--status`, `--platform`, `--app-version`, …). Anything a command supports that has no dedicated flag can be passed through `--filters`:

```bash
luciq crashes list --slug my-app --mode production \
  --filters '{"devices":["iPhone15,2"],"os_versions":["17.4"]}'
```

When a typed flag and a `--filters` key overlap, the typed flag wins. Run `luciq <group> help <subcommand>` for the full option list and the filter keys each command accepts.

### Output

Responses print as pretty-printed JSON, so they pipe cleanly into `jq` and scripts. Commands exit with a non-zero status on any error.

### Permissions and rate limits

The CLI token represents your dashboard account: each command is authorized against your role's permissions and your plan's entitlements, exactly like the corresponding MCP tool. Requests are rate-limited to **100 requests per 60 seconds**; exceeding the limit returns an HTTP `429` error with a `Rate limit exceeded` message — back off and retry.

***

## Crashes

`luciq crashes SUBCOMMAND`

| Subcommand                       | Description                                                                                                                                                                      |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `list`                           | List crashes. Flags: `--status` (`open`/`closed`/`in_progress`), `--platform` (`IOS`/`ANDROID`/`DART`/`JAVASCRIPT`), `--type` (`CRASH`/`ANR`/`OOM`/`NON_FATAL`), `--app-version` |
| `show --number N`                | Details for one crash                                                                                                                                                            |
| `patterns --number N`            | Grouped patterns. Flags: `--pattern-key` (`app_versions`/`devices`/`oses`/`current_views`/`app_status`/`experiments`), `--sort-by`, `--direction`                                |
| `diagnostics --number N`         | Full debugging payload for one crash                                                                                                                                             |
| `hangs`                          | List app hangs. Flags: `--status`, `--platform`, `--app-version`                                                                                                                 |
| `occurrence-tokens --number N`   | Occurrence cursor tokens. Flags: `--current-token`, `--direction` (`first`/`last`)                                                                                               |
| `occurrence --number N --ulid U` | Details for a single occurrence                                                                                                                                                  |

Sortable fields for `list` and `hangs`: `last_occurred_at`, `first_occurred_at`, `occurrences_counter`, `affected_users_counter`, `max_app_version`, `min_app_version`, `severity`.

```bash
luciq crashes list --slug my-app --mode production --status open --limit 20
luciq crashes show --slug my-app --mode production --number 42
luciq crashes patterns --slug my-app --mode production --number 42 --pattern-key devices
```

***

## Bugs

`luciq bugs SUBCOMMAND`

| Subcommand          | Description                                                                                                                           |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `list`              | List bugs. Flags: `--status` (`new`/`closed`/`in_progress`), `--priority` (`na`/`trivial`/`minor`/`major`/`blocker`), `--app-version` |
| `show --number N`   | Details for one bug                                                                                                                   |
| `update --number N` | Update a bug. Flags: `--status`, `--priority`, `--tags`, `--clear-tags`, `--duplicate-of`, `--action`                                 |

```bash
luciq bugs update --slug my-app --mode production --number 7 --status closed --priority major
luciq bugs update --slug my-app --mode production --number 7 --duplicate-of 3
```

`update` requires at least one change. Duplicate marking (`--duplicate-of` or `--action mark_as_duplicate`/`unmark_as_duplicate`) can't be combined with `--status`/`--priority`. `--tags` replaces the bug's existing tags; use `--clear-tags` to remove all tags.

***

## APM

`luciq apm SUBCOMMAND`

| Subcommand                             | Description                                                                                                                                                      |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `groups --metric M`                    | Rank groups worst-first. `--metric`: `network`, `launch`, `flows`, `screen_loading`, `frame_drop`, `funnels`. `--sort` is a JSON object `{"by":…,"direction":…}` |
| `group --metric M`                     | Panels for one group; identify it with `--group-uuid` or `--group-url`. `--views` is a JSON array (default `["summary"]`); `--method` applies to network         |
| `occurrence --metric M --selector S`   | Inspect occurrences (`--selector`: `worst`/`by_token`/`list`). Flags: `--token`, `--current-token`, `--direction` (`first`/`last`), `--limit`                    |
| `funnel-events`                        | List events pickable for funnels. Flags: `--event-type` (`network`/`screen_loading`), `--q`, `--limit`                                                           |
| `funnel-create --name N --events JSON` | Create a funnel from 2–20 steps                                                                                                                                  |
| `funnel-update --ulid U`               | Update a funnel (`--name`, `--events`)                                                                                                                           |
| `funnel-delete --ulid U`               | Delete a funnel                                                                                                                                                  |

```bash
luciq apm groups --slug my-app --mode production --metric network \
  --sort '{"by":"p95","direction":"desc"}'
```

***

## Reviews

`luciq reviews list` — Flags: `--rating` (1–5), `--country`, `--os` (`ios`/`android`), `--sort-by date`, `--sort-direction`.

```bash
luciq reviews list --slug my-app --mode production --rating 1 2 --os ios
```

***

## Surveys

`luciq surveys SUBCOMMAND`

| Subcommand    | Description                                                                                                           |
| ------------- | --------------------------------------------------------------------------------------------------------------------- |
| `list`        | List surveys. Flags: `--type` (`0`=custom, `1`=NPS, `2`=app store), `--status` (`0`=draft, `1`=published, `2`=paused) |
| `show --id N` | A survey's questions and response statistics. `--page` paginates responses                                            |

***

## Apps

`luciq apps list` — List the applications you can access. This is the one data command with no `--slug`/`--mode`. Optional `--platform` (`ios`/`android`/`react_native`/`flutter`).

***

## Insights

`luciq insights --slug my-app --mode production` — Aggregated app-health insights for one app. Narrow with `--filters` (`date_ms`, `app_version`).

***

## Issues

`luciq issues list` — Unified issues across crashes, APM, AI-detected issues, and bugs, ranked by Apdex impact. Flags: `--limit`, `--sort-by` (`apdex_impact`/`occurrences_counter`), `--sort-direction`, `--top-issues` (curated shortlist), `--pagination` (per-source cursor tokens JSON).

***

## Opportunities

`luciq opportunities SUBCOMMAND`

| Subcommand    | Description                                                                                                                    |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `list`        | List opportunities. Flags: `--status` (`open`/`in_progress`/`closed`/`dismissed`), `--priority` (`1`–`4`/`unset`), `--team-id` |
| `show --id N` | Details for one opportunity                                                                                                    |

***

## Alerts

`luciq alerts SUBCOMMAND` — Manage alert rules.

| Subcommand                       | Description                                                                                                            |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `list`                           | List rules. Flags: `--sort-by` (`latest_creation_date`/`last_edit_date`/`highest_triggered_count`), `--sort-direction` |
| `show --ulid U`                  | Show one rule                                                                                                          |
| `init`                           | Show the building blocks (types, triggers, conditions, actions) for creating a rule                                    |
| `create --payload JSON`          | Create a rule                                                                                                          |
| `update --ulid U --payload JSON` | Update a rule                                                                                                          |
| `delete --ulid U`                | Delete a rule                                                                                                          |

Run `luciq alerts init` first to discover the valid rule building blocks, then pass the rule body as `--payload`:

```bash
luciq alerts init --slug my-app --mode production
luciq alerts create --slug my-app --mode production --payload '{"title":"…", …}'
```

***

## Incidents

`luciq incidents SUBCOMMAND` — Manage triggered alerts.

| Subcommand         | Description                                                                                                                                                             |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `list`             | List incidents. Flags: `--sort-by` (`first_triggered`/`last_triggered`/`count`), `--sort-direction`, `--status` (`open`/`manual_resolve`/`automatic_resolve`), `--type` |
| `show --ulid U`    | Show one incident                                                                                                                                                       |
| `resolve --ulid U` | Resolve an incident                                                                                                                                                     |
| `reopen --ulid U`  | Reopen an incident                                                                                                                                                      |


---

# 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/command-reference.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.
