npm package: @olane/o-cli
Description: Command-line interface for the [Olane Network](https://olane.dev) — interact with the Copass knowledge graph, ingest code and documentation, and query your project's ontology.
Author: Olane Inc.
Latest version: 2.2.4

# Olane CLI

Command-line interface for the [Olane Network](https://olane.dev) — interact with the Copass knowledge graph, ingest code and documentation, and query your project's ontology.

## Installation

### npm (recommended)

```bash
npm install -g @olane/o-cli
```

### Homebrew

```bash
brew tap olane-labs/tap
brew install olane
```

### From source

```bash
git clone https://github.com/olane-labs/o-cli.git
cd o-cli
pnpm install
pnpm build
```

Requires Node.js >= 20.0.0.

## Quick start

```bash
# Authenticate
olane login

# Initialize your project
olane setup

# Index your codebase
olane index --mode full

# Start continuous incremental indexing in the foreground
olane watch

# Query the knowledge graph
olane copass question "How does authentication work in this project?"

# Search for entities
olane search "UserService"
```

## Commands

### Authentication

| Command        | Description                           |
| -------------- | ------------------------------------- |
| `olane login`  | Sign in with email (OTP verification) |
| `olane logout` | Clear stored auth tokens              |

### Project

| Command                                  | Description                                           |
| ---------------------------------------- | ----------------------------------------------------- |
| `olane setup`                            | Interactive project initialization                    |
| `olane status`                           | Check indexing status and project health              |
| `olane index --mode <full\|incremental>` | Index project for ontology enrichment                 |
| `olane watch`                            | Watch the project for continuous incremental indexing |
| `olane watch status`                     | Check watch service health and last sync              |
| `olane watch install-service`            | Install and start the background watch service        |
| `olane watch uninstall-service`          | Remove the background watch service                   |

### Copass (Knowledge Graph)

| Command                               | Description                                                           |
| ------------------------------------- | --------------------------------------------------------------------- |
| `olane copass question <question>`    | Natural language Q&A against your ontology                            |
| `olane copass context <canonical-id>` | Get LLM-generated context summary for an entity                       |
| `olane copass score <query>`          | Score knowledge graph coverage for an entity name, UUID, or free text |

### Search & Ingestion

| Command                    | Description                              |
| -------------------------- | ---------------------------------------- |
| `olane search <query>`     | Search ontology by name or description   |
| `olane ingest code [file]` | Ingest source code for entity extraction |
| `olane ingest text [file]` | Ingest text or documentation             |

### Configuration

| Command                          | Description            |
| -------------------------------- | ---------------------- |
| `olane config set <key> <value>` | Set a config value     |
| `olane config get <key>`         | Get a config value     |
| `olane config list`              | List all config values |

### MCP Server

```bash
olane copass --mcp
```

Starts a [Model Context Protocol](https://modelcontextprotocol.io) server over stdio, exposing all CLI capabilities as tools for AI agents.

## MCP integration

Add Olane as an MCP server in your `.mcp.json`:

```json
{
  "mcpServers": {
    "olane": {
      "type": "stdio",
      "command": "olane",
      "args": ["copass", "--mcp"]
    }
  }
}
```

### Available MCP tools

| Tool                   | Description                                                                                                                        |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `check_project_status` | Check project indexing status                                                                                                      |
| `context_query`        | Natural language ontology queries                                                                                                  |
| `context_summary`      | LLM-generated context summary for a canonical entity                                                                               |
| `search_entities`      | Search the ontology                                                                                                                |
| `ingest_code`          | Ingest source code                                                                                                                 |
| `ingest_text`          | Ingest text/documentation                                                                                                          |
| `get_score`            | Score knowledge graph coverage for an entity, UUID, or free text; high scores → use `context_query`/`context_summary` for insights |

## Copass scoring

Cosync scores measure confidence in the knowledge graph's understanding of entities:

| Tier           | Meaning                                            |
| -------------- | -------------------------------------------------- |
| **safe**       | High confidence, well-understood entity            |
| **review**     | Moderate confidence, may benefit from verification |
| **caution**    | Low confidence, likely needs enrichment            |
| **critical**   | Very low confidence, significant gaps              |
| **cold_start** | New entity with minimal data                       |

Use `olane copass context <canonical-id>` to get an LLM-generated summary of an entity's context.

## Supported languages

Code ingestion supports: TypeScript, JavaScript, Python, Rust, Go, Java, Ruby, PHP, C, C++, C#, Swift, Kotlin, Scala, Bash, SQL, YAML, JSON, Markdown, HTML, CSS, SCSS, Vue, and Svelte.

## Configuration

### Global config (`~/.olane/config.json`)

Stores authentication tokens, API endpoints, and encryption keys. Created automatically on `olane login`.

### Project config (`.olane/config.json`)

Stores project-specific settings including cosync thresholds, indexing schedules, and hook configuration. Created by `olane setup`.
Continuous indexing settings are stored under the `watch` section, and successful full indexes refresh `.olane/watch-state.json` so background watching can resume without re-uploading unchanged files.

### Environment variables

| Variable               | Description                                    |
| ---------------------- | ---------------------------------------------- |
| `OLANE_API_URL`        | API endpoint (default: `https://ai.copass.id`) |
| `OLANE_ENCRYPTION_KEY` | Master encryption key                          |
| `OLANE_PROJECT_ID`     | Default project ID                             |

## Security

All data in transit is encrypted using AES-256-GCM. Each project can have its own master encryption key, stored locally or provided via environment variable. Session tokens wrap a derived encryption key with your access token for secure API communication.

## License

MIT
hi