> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clix.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Clix CLI

> An AI-powered CLI to integrate, diagnose, and manage the Clix Mobile SDK through your favorite AI coding agent.

Clix CLI helps you integrate, diagnose, and manage the Clix Mobile SDK through your favorite AI coding agent. It prepares your project configuration, then hands off to an AI agent for seamless SDK setup across iOS, Android, React Native, and Flutter projects.

## Installation

<CodeGroup>
  ```bash npm theme={null}
  npm install -g @clix-so/clix-cli
  ```

  ```bash bun theme={null}
  bun add -g @clix-so/clix-cli
  ```

  ```bash shell theme={null}
  curl -fsSL https://clix.sh/install | bash
  ```

  ```bash homebrew theme={null}
  brew tap clix-so/clix-cli && brew install clix
  ```
</CodeGroup>

## Requirements

* Node.js 20 or higher
* One supported AI agent (see table below)

## Supported AI Agents

| Agent          | Access                             | Notes                      |
| -------------- | ---------------------------------- | -------------------------- |
| Gemini CLI     | Free (1,000 requests/day)          | Recommended for free users |
| GitHub Copilot | Free (50 monthly premium requests) | Recommended for free users |
| OpenCode       | Varies                             | -                          |
| Cursor         | Subscription                       | -                          |
| Claude Code    | Subscription                       | -                          |
| Codex          | Subscription                       | -                          |

<Note>
  Gemini CLI and GitHub Copilot offer generous free tiers, making them ideal starting points if you don't have an existing subscription.
</Note>

## Quick Start

```bash theme={null}
# 1. Install the CLI
curl -fsSL https://clix.sh/install | bash

# 2. Authenticate
clix login

# 3. Install the SDK
clix install
```

## Commands

### Core

#### `clix install`

Auto-configure push notifications in your project. Runs a two-step process: first prepares your project configuration (Firebase, APNs, entitlements), then hands off to your selected AI agent for SDK installation.

```bash theme={null}
clix install
```

#### `clix doctor`

Diagnose your project's Clix SDK integration status. Checks configuration completeness and hands off to your AI agent for detailed analysis and fixes.

```bash theme={null}
clix doctor
```

#### `clix mcp`

Install the Clix MCP Server, enabling AI agents to access real-time Clix documentation and SDK code examples.

```bash theme={null}
clix mcp
```

#### `clix skills`

Install Clix Skills for your AI agent, providing pre-built workflows for SDK integration, event tracking, user management, and more.

```bash theme={null}
clix skills
```

### Utility

#### `clix login`

Authenticate with your Clix account via device flow.

```bash theme={null}
clix login
```

#### `clix logout`

Remove stored credentials.

```bash theme={null}
clix logout
```

#### `clix whoami`

Show the current logged-in user.

```bash theme={null}
clix whoami
```

#### `clix agent [name]`

List available agents or switch to a specific agent.

```bash theme={null}
# List all available agents
clix agent

# Switch to a specific agent
clix agent gemini
```

#### `clix update`

Check for and apply CLI updates.

```bash theme={null}
clix update

# Preview without applying
clix update --dry-run
```

#### `clix uninstall`

Remove the CLI from your system.

```bash theme={null}
clix uninstall

# Keep configuration files
clix uninstall --keep-config
```

#### `clix help`

Show available commands.

```bash theme={null}
clix help
```

## Key Features

* **Command-Mode Architecture**: Dedicated commands for each workflow — no interactive chat session required
* **Two-Step Install Process**: Automated project preparation followed by AI agent handoff for SDK integration
* **Multiple Agent Support**: Choose from 6 AI agents and switch between them at any time
* **Platform Detection**: Automatically identifies your project type and provides tailored configuration
* **Auto-Update**: Built-in update mechanism that detects your install method and applies updates accordingly

## Related Resources

<CardGroup cols={2}>
  <Card title="Agent Skills" icon="wand-magic-sparkles" href="/agent-skills">
    Pre-built skills for SDK integration, event tracking, user management, and more.
  </Card>

  <Card title="MCP Server" icon="server" href="/mcp-server/clix-mcp-server">
    Enable AI agents to access real-time Clix documentation and SDK examples.
  </Card>
</CardGroup>

> **Feedback & Issues**
>
> For any issues or feature requests, please open an issue on [GitHub](https://github.com/clix-so/clix-cli).