npm package: @superlines/aisearchindex
Description: CLI for AI Search Index - Track AI bot traffic on your website
Author: AI Search Index
Latest version: 1.0.0

# AI Search Index CLI

The official CLI for [AI Search Index](https://aisearchindex.com) - Track AI bot traffic on your website.

## Installation

```bash
npm install -g @superlines/aisearchindex
```

Or use directly with npx:

```bash
npx @superlines/aisearchindex init
```

## Quick Start

### 1. Initialize tracking in your project

```bash
npx @superlines/aisearchindex init
```

This will:
1. Open your browser to authenticate with AI Search Index
2. Detect your project's framework (Next.js, React, Vue, Astro, etc.)
3. Let you select an existing website or create a new one
4. Automatically add the tracking code to your project

### 2. Deploy and view analytics

After deploying your changes, visit [aisearchindex.com/dashboard](https://aisearchindex.com/dashboard) to see which AI bots are visiting your site.

## Commands

### `aisearchindex init`

Initialize AI Search Index tracking in your project.

```bash
npx @superlines/aisearchindex init
npx @superlines/aisearchindex init --tracking-id tid_xxxxx  # Use existing tracking ID
npx @superlines/aisearchindex init --no-install             # Skip automatic code insertion
```

### `aisearchindex login`

Authenticate with AI Search Index.

```bash
npx @superlines/aisearchindex login
```

Opens your browser to complete authentication. Your API key is stored securely in your system's config directory.

### `aisearchindex logout`

Remove stored credentials.

```bash
npx @superlines/aisearchindex logout
```

### `aisearchindex status`

Check authentication and connection status.

```bash
npx @superlines/aisearchindex status
```

### `aisearchindex websites`

List all your tracked websites.

```bash
npx @superlines/aisearchindex websites
```

## Supported Frameworks

The CLI can automatically add tracking code to:

- **Next.js** (App Router & Pages Router)
- **Astro**
- **Remix**
- **SvelteKit**
- **Vue / Nuxt**
- **React** (Vite, CRA)
- **Static HTML**

For other frameworks, the CLI will provide copy-paste instructions.

## Environment Variables

You can also authenticate using environment variables:

```bash
export AISEARCHINDEX_API_KEY=sk_live_xxxxx
npx @superlines/aisearchindex status
```

Optional:

```bash
export AISEARCHINDEX_API_URL=https://aisearchindex.com  # Custom API URL
```

## Configuration

Credentials are stored in:

- **macOS**: `~/Library/Preferences/aisearchindex-nodejs/config.json`
- **Linux**: `~/.config/aisearchindex-nodejs/config.json`
- **Windows**: `%APPDATA%\aisearchindex-nodejs\Config\config.json`

## What Gets Tracked

AI Search Index detects 100+ bots including:

**AI Training Crawlers:**
- GPTBot (OpenAI)
- ClaudeBot (Anthropic)
- Google-Extended (Google AI)
- Bytespider (ByteDance)
- CCBot (Common Crawl)

**AI Search/Chat Bots:**
- ChatGPT-User (OpenAI)
- PerplexityBot (Perplexity AI)
- Claude-Web (Anthropic)

**Search Engines:**
- Googlebot, Bingbot, DuckDuckBot, YandexBot, Applebot

## Privacy

- **No cookies** - The tracking pixel doesn't use cookies
- **GDPR compliant** - No personal data collection
- **Lightweight** - ~1KB script

## MCP Integration

For AI-native workflows, install our MCP server:

```bash
npm install -g @superlines/aisearchindex-mcp
```

See [MCP documentation](https://aisearchindex.com/docs/mcp) for setup instructions.

## Support

- **Documentation**: [aisearchindex.com/docs](https://aisearchindex.com/docs)
- **FAQ**: [aisearchindex.com/faq](https://aisearchindex.com/faq)
- **Contact**: [aisearchindex.com/contact](https://aisearchindex.com/contact)

## License

MIT