Metadata-Version: 2.4
Name: ontora-cli
Version: 0.1.0
Summary: Ontora CLI — manage interview campaigns, transcripts, reports, and webhooks from the terminal.
Author: Ontora
License-Expression: LicenseRef-Proprietary
Project-URL: Documentation, https://docs.ontora.com/cli/install
Project-URL: API, https://docs.ontora.com/api-reference/introduction
Project-URL: Homepage, https://docs.ontora.com
Keywords: ontora,interviews,research,synthesis,cli
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: typer>=0.12.0
Requires-Dist: httpx>=0.27.0
Requires-Dist: rich>=13.7.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: pydantic>=2.6.0

# Ontora CLI

Manage Ontora interview campaigns, transcripts, reports, and webhooks from the terminal.

## Install

```bash
pip install ontora-cli
# or, from this repo:
cd cli && pip install -e .
```

## Setup

```bash
ontora auth login           # Paste your API key (or set ONTORA_API_KEY)
ontora auth status          # Verify connection
```

Get an API key from the Ontora web app (Settings → API Keys) or via
`POST /v1/api-keys`. You'll also need to know your workspace ID.

```bash
export ONTORA_WORKSPACE_ID=<uuid>
# or set per-command with --workspace
```

## Campaigns

```bash
ontora campaigns list
ontora campaigns create --config campaign.yaml
ontora campaigns show <id>
ontora campaigns start <id>
ontora campaigns pause <id>
```

### Config-as-code (YAML)

```yaml
name: "Q2 Procurement Discovery"
goal: "Map end-to-end procurement workflow to identify automation opportunities"
channel: in_app_chat
duration_minutes: 30
interview_context_for_employee: >
  We're mapping how procurement works across the organization.
success_criteria: >
  Complete process map with step-level pain points from every department.

topics:
  - name: "Daily Workflow"
    goal: "Understand the step-by-step procurement process"
    priority: required
    success_threshold: "Can describe process end-to-end with tools used"
    sub_topics: ["intake", "approval", "vendor selection", "PO creation"]
    questions:
      - text: "Walk me through a typical purchase request"
        required: true
      - text: "What tools do you use at each step?"

contacts:
  - name: "Jane Smith"
    email: "jane@company.com"
    department: "Procurement"
    job_title: "Senior Buyer"
    seniority_level: 4
  # Or: { file: contacts.csv }
```

## Transcripts and reports

```bash
ontora transcripts list <campaign-id>
ontora transcripts get <campaign-id> <conversation-id>
ontora transcripts export <campaign-id> [--output ./out]  # ZIP of .md files
ontora reports show <campaign-id>
ontora reports export <campaign-id> [--output report.md]
```

## Graph RAG query

```bash
ontora query <campaign-id> "What are the top pain points across procurement?"
```

## Webhooks

```bash
ontora webhooks list
ontora webhooks add https://your-app.example/hook --events interview.completed,campaign.completed
ontora webhooks test <id>
ontora webhooks remove <id>
```
