ontora-cli 0.1.0__tar.gz

ontora_cli-0.1.0/PKG-INFO

@@ -0,0 +1,118 @@
+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>
+```

ontora_cli-0.1.0/README.md

@@ -0,0 +1,93 @@
+# 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>
+```

ontora_cli-0.1.0/ontora_cli/__init__.py

@@ -0,0 +1,3 @@
+"""Ontora CLI."""
+
+__version__ = "0.1.0"

ontora_cli-0.1.0/ontora_cli/client.py

@@ -0,0 +1,72 @@
+"""Thin httpx wrapper around the Ontora REST API."""
+
+from __future__ import annotations
+
+import json
+from typing import Any
+
+import httpx
+
+from ontora_cli.config import CliConfig
+
+
+class ApiError(Exception):
+    def __init__(self, status: int, detail: Any):
+        self.status = status
+        self.detail = detail
+        super().__init__(f"HTTP {status}: {detail}")
+
+
+class OntoraClient:
+    def __init__(self, cfg: CliConfig, api_key: str):
+        self.cfg = cfg
+        self._client = httpx.Client(
+            base_url=cfg.base_url,
+            headers={"X-API-Key": api_key, "User-Agent": "ontora-cli/0.1.0"},
+            timeout=60.0,
+            follow_redirects=True,
+        )
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> "OntoraClient":
+        return self
+
+    def __exit__(self, *_: Any) -> None:
+        self.close()
+
+    def _raise(self, r: httpx.Response) -> None:
+        if r.is_success:
+            return
+        try:
+            detail = r.json()
+        except json.JSONDecodeError:
+            detail = r.text
+        raise ApiError(r.status_code, detail)
+
+    # ------------------------------------------------------------------ HTTP
+    def get(self, path: str, params: dict | None = None) -> Any:
+        r = self._client.get(path, params=params)
+        self._raise(r)
+        return r.json() if r.content else None
+
+    def post(self, path: str, json_body: dict | None = None, params: dict | None = None) -> Any:
+        r = self._client.post(path, json=json_body, params=params)
+        self._raise(r)
+        return r.json() if r.content else None
+
+    def patch(self, path: str, json_body: dict) -> Any:
+        r = self._client.patch(path, json=json_body)
+        self._raise(r)
+        return r.json() if r.content else None
+
+    def delete(self, path: str) -> None:
+        r = self._client.delete(path)
+        self._raise(r)
+
+    def get_raw(self, path: str, params: dict | None = None) -> httpx.Response:
+        """Return the raw response (for downloading binary/markdown)."""
+        r = self._client.get(path, params=params)
+        self._raise(r)
+        return r

ontora_cli-0.1.0/ontora_cli/commands/auth.py

@@ -0,0 +1,40 @@
+"""Auth commands: login, status."""
+
+from __future__ import annotations
+
+import typer
+from rich import print as rprint
+
+from ontora_cli.client import ApiError, OntoraClient
+from ontora_cli.config import load_config, save_config
+
+app = typer.Typer(help="API key and connection management.")
+
+
+@app.command()
+def login(
+    api_key: str = typer.Option(..., "--api-key", "-k", prompt=True, hide_input=True, help="Your Ontora API key (ont_...)"),
+    base_url: str | None = typer.Option(None, "--base-url", help="Override API base URL."),
+    workspace: str | None = typer.Option(None, "--workspace", help="Default workspace ID."),
+) -> None:
+    """Save an API key + optional defaults to ~/.ontora/config.yaml."""
+    save_config(api_key=api_key, base_url=base_url, workspace_id=workspace)
+    rprint("[green]Saved credentials to ~/.ontora/config.yaml[/green]")
+
+
+@app.command()
+def status() -> None:
+    """Verify the API key works by calling the health endpoint."""
+    cfg = load_config()
+    if not cfg.api_key:
+        rprint("[red]No API key configured.[/red] Run `ontora auth login`.")
+        raise typer.Exit(1)
+    try:
+        with OntoraClient(cfg, cfg.api_key) as c:
+            c.get("/v1/health")
+        rprint(f"[green]Connected.[/green] base_url={cfg.base_url}")
+        if cfg.workspace_id:
+            rprint(f"Default workspace: {cfg.workspace_id}")
+    except ApiError as e:
+        rprint(f"[red]API error ({e.status}):[/red] {e.detail}")
+        raise typer.Exit(1)

ontora_cli-0.1.0/ontora_cli/commands/campaigns.py

@@ -0,0 +1,161 @@
+"""Campaign commands: list, create (from YAML), show, start, pause."""
+
+from __future__ import annotations
+
+import csv
+from pathlib import Path
+
+import typer
+import yaml
+from rich import print as rprint
+from rich.console import Console
+from rich.panel import Panel
+
+from ontora_cli.client import ApiError, OntoraClient
+from ontora_cli.config import load_config, require_api_key, require_workspace
+from ontora_cli.formatters import print_campaigns
+from ontora_cli.schemas import CampaignYaml
+
+app = typer.Typer(help="Manage interview campaigns.")
+console = Console()
+
+
+@app.command("list")
+def list_cmd(
+    workspace: str | None = typer.Option(None, "--workspace", "-w"),
+    status: str | None = typer.Option(None, "--status", help="Filter by draft/active/paused/completed"),
+) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    ws = require_workspace(cfg, workspace)
+    params = {"workspace_id": ws}
+    if status:
+        params["status"] = status
+    with OntoraClient(cfg, key) as c:
+        data = c.get("/v1/interviews", params=params)
+    print_campaigns(data or [])
+
+
+@app.command("show")
+def show_cmd(interview_id: str) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        data = c.get(f"/v1/interviews/{interview_id}/detail")
+        progress = None
+        try:
+            progress = c.get(f"/v1/interviews/{interview_id}/progress")
+        except ApiError:
+            pass
+    rprint(Panel.fit(f"[bold]{data['name']}[/bold]\n{data.get('goal') or ''}", title="Campaign"))
+    rprint(f"Status: [cyan]{data.get('status')}[/cyan]  Channel: {data.get('channel')}")
+    if progress:
+        rprint(
+            f"Progress: {progress.get('completed', 0)}/{progress.get('total', 0)} "
+            f"({progress.get('completion_percent', 0):.1f}%)"
+        )
+    rprint(f"Topics: {len(data.get('question_sets') or [])}  Contacts: {len(data.get('contacts') or [])}")
+
+
+@app.command("create")
+def create_cmd(
+    config_file: Path = typer.Option(..., "--config", "-c", exists=True, readable=True, help="Campaign YAML file"),
+    workspace: str | None = typer.Option(None, "--workspace", "-w"),
+    start: bool = typer.Option(False, "--start", help="Start the campaign immediately after creation"),
+) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    ws = require_workspace(cfg, workspace)
+
+    with config_file.open() as f:
+        raw = yaml.safe_load(f)
+    spec = CampaignYaml.model_validate(raw)
+
+    with OntoraClient(cfg, key) as c:
+        # 1. Create interview shell
+        create_body = {
+            "workspace_id": ws,
+            "name": spec.name,
+            "goal": spec.goal,
+            "description": spec.description,
+            "channel": spec.channel,
+            "interview_duration_minutes": spec.duration_minutes,
+            "completion_threshold": spec.completion_threshold,
+            "interview_context_for_employee": spec.interview_context_for_employee,
+            "success_criteria": spec.success_criteria,
+            "agent_behavior": spec.agent_behavior,
+            "welcome_screen": spec.welcome_screen,
+            "closing_message": spec.closing_message,
+            "timezone": spec.timezone,
+            "interview_order": "seniority_high_first",
+        }
+        create_body = {k: v for k, v in create_body.items() if v is not None}
+        interview = c.post("/v1/interviews", json_body=create_body)
+        interview_id = interview["id"]
+        rprint(f"[green]Created campaign[/green] {interview_id}")
+
+        # 2. Question sets
+        for idx, topic in enumerate(spec.topics):
+            qset_body = {
+                "name": topic.name,
+                "description": topic.goal,
+                "sort_order": idx,
+                "topic_metadata": {
+                    "priority": topic.priority,
+                    "success_threshold": topic.success_threshold,
+                    "sub_topics": topic.sub_topics,
+                },
+                "questions": [
+                    {"question_text": q.text, "is_required": q.required, "sort_order": qi}
+                    for qi, q in enumerate(topic.questions)
+                ],
+            }
+            c.post(f"/v1/interviews/{interview_id}/question-sets", json_body=qset_body)
+        if spec.topics:
+            rprint(f"[green]Added {len(spec.topics)} topic(s)[/green]")
+
+        # 3. Contacts — inline + CSV references
+        inline_contacts = []
+        csv_contacts = []
+        for contact in spec.contacts:
+            if contact.file:
+                csv_path = (config_file.parent / contact.file).resolve()
+                with open(csv_path) as f:
+                    for row in csv.DictReader(f):
+                        csv_contacts.append({k.strip(): v for k, v in row.items() if v})
+            else:
+                d = contact.model_dump(exclude_none=True, exclude={"file"})
+                if d:
+                    inline_contacts.append(d)
+
+        all_contacts = inline_contacts + csv_contacts
+        if all_contacts:
+            c.post(
+                f"/v1/interviews/{interview_id}/contacts/bulk",
+                json_body={"contacts": all_contacts},
+            )
+            rprint(f"[green]Added {len(all_contacts)} contact(s)[/green]")
+
+        if start:
+            resp = c.post(f"/v1/interviews/{interview_id}/start")
+            rprint(f"[bold green]Started![/bold green] {resp.get('message', '')}")
+
+    rprint(f"\nView: {cfg.base_url.replace('api.', 'app.')}/interviews/{interview_id}")
+
+
+@app.command("start")
+def start_cmd(interview_id: str) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        resp = c.post(f"/v1/interviews/{interview_id}/start")
+    rprint(f"[green]{resp.get('message', 'Started.')}[/green]")
+
+
+@app.command("pause")
+def pause_cmd(interview_id: str) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        c.post(f"/v1/interviews/{interview_id}/pause")
+    rprint("[yellow]Paused.[/yellow]")

ontora_cli-0.1.0/ontora_cli/commands/contacts.py

@@ -0,0 +1,64 @@
+"""Contact commands."""
+
+from __future__ import annotations
+
+import csv
+from pathlib import Path
+
+import typer
+from rich import print as rprint
+
+from ontora_cli.client import OntoraClient
+from ontora_cli.config import load_config, require_api_key
+from ontora_cli.formatters import print_contacts
+
+app = typer.Typer(help="Contacts.")
+
+
+@app.command("list")
+def list_cmd(interview_id: str, status: str | None = typer.Option(None, "--status")) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    params = {"status": status} if status else None
+    with OntoraClient(cfg, key) as c:
+        data = c.get(f"/v1/interviews/{interview_id}/contacts", params=params)
+    print_contacts(data or [])
+
+
+@app.command("add")
+def add_cmd(
+    interview_id: str,
+    name: str = typer.Option(..., "--name"),
+    email: str | None = typer.Option(None, "--email"),
+    phone: str | None = typer.Option(None, "--phone"),
+    job_title: str | None = typer.Option(None, "--job-title"),
+    department: str | None = typer.Option(None, "--department"),
+    seniority_level: int | None = typer.Option(None, "--seniority"),
+) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    body = {
+        "name": name,
+        "email": email,
+        "phone": phone,
+        "job_title": job_title,
+        "department": department,
+        "seniority_level": seniority_level,
+    }
+    body = {k: v for k, v in body.items() if v is not None}
+    with OntoraClient(cfg, key) as c:
+        resp = c.post(f"/v1/interviews/{interview_id}/contacts", json_body=body)
+    rprint(f"[green]Added {resp.get('name')} ({resp.get('id')})[/green]")
+
+
+@app.command("import")
+def import_cmd(interview_id: str, csv_path: Path = typer.Argument(..., exists=True, readable=True)) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    rows = []
+    with csv_path.open() as f:
+        for r in csv.DictReader(f):
+            rows.append({k.strip(): v for k, v in r.items() if v})
+    with OntoraClient(cfg, key) as c:
+        resp = c.post(f"/v1/interviews/{interview_id}/contacts/bulk", json_body={"contacts": rows})
+    rprint(f"[green]Imported {resp.get('created', len(rows))} contacts[/green]")

ontora_cli-0.1.0/ontora_cli/commands/query.py

@@ -0,0 +1,41 @@
+"""Graph RAG query command."""
+
+from __future__ import annotations
+
+import typer
+from rich import print as rprint
+from rich.markdown import Markdown
+from rich.panel import Panel
+
+from ontora_cli.client import OntoraClient
+from ontora_cli.config import load_config, require_api_key
+
+app = typer.Typer()
+
+
+@app.callback(invoke_without_command=True)
+def query(
+    interview_id: str = typer.Argument(...),
+    question: str = typer.Argument(...),
+) -> None:
+    """Ask a natural-language question about a campaign's data."""
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        resp = c.post(
+            f"/v1/interviews/{interview_id}/graph/query",
+            json_body={"question": question},
+        )
+    answer = resp.get("answer") or ""
+    rprint(Panel(Markdown(answer), title="Answer", border_style="cyan"))
+
+    patterns = resp.get("patterns") or []
+    if patterns:
+        rprint("\n[bold]Patterns[/bold]")
+        for p in patterns:
+            rprint(f"- {p.get('text', p)}")
+    divergences = resp.get("divergences") or []
+    if divergences:
+        rprint("\n[bold]Divergences[/bold]")
+        for d in divergences:
+            rprint(f"- {d.get('text', d)}")

ontora_cli-0.1.0/ontora_cli/commands/reports.py

@@ -0,0 +1,39 @@
+"""Report / synthesis commands."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+from rich import print as rprint
+from rich.markdown import Markdown
+
+from ontora_cli.client import OntoraClient
+from ontora_cli.config import load_config, require_api_key
+
+app = typer.Typer(help="Synthesis reports.")
+
+
+@app.command("show")
+def show_cmd(interview_id: str) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        resp = c.get_raw(f"/v1/interviews/{interview_id}/export/summary")
+    rprint(Markdown(resp.text))
+
+
+@app.command("export")
+def export_cmd(
+    interview_id: str,
+    kind: str = typer.Option("report", "--kind", "-k", help="report | summary"),
+    output: Path | None = typer.Option(None, "--output", "-o"),
+) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    endpoint = f"/v1/interviews/{interview_id}/export/{kind}"
+    with OntoraClient(cfg, key) as c:
+        resp = c.get_raw(endpoint)
+    out = output or Path(f"{interview_id[:8]}_{kind}.md")
+    out.write_text(resp.text)
+    rprint(f"[green]Wrote {out}[/green]")

ontora_cli-0.1.0/ontora_cli/commands/transcripts.py

@@ -0,0 +1,65 @@
+"""Transcript and report commands."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+from rich import print as rprint
+from rich.markdown import Markdown
+
+from ontora_cli.client import OntoraClient
+from ontora_cli.config import load_config, require_api_key
+from ontora_cli.formatters import print_transcripts
+
+app = typer.Typer(help="Transcripts.")
+
+
+@app.command("list")
+def list_cmd(interview_id: str) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        data = c.get(f"/v1/interviews/{interview_id}/conversations")
+    # The endpoint may return {"conversations": [...]} or a list; handle both.
+    rows = data.get("conversations") if isinstance(data, dict) else data
+    print_transcripts(rows or [])
+
+
+@app.command("get")
+def get_cmd(
+    interview_id: str,
+    conversation_id: str,
+    format: str = typer.Option("md", "--format", "-f", help="md | json"),
+    output: Path | None = typer.Option(None, "--output", "-o", help="Write to file instead of stdout"),
+) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        if format == "json":
+            data = c.get(f"/v1/interviews/{interview_id}/conversations/{conversation_id}")
+            text = __import__("json").dumps(data, indent=2, default=str)
+        else:
+            resp = c.get_raw(f"/v1/interviews/{interview_id}/export/transcript/{conversation_id}")
+            text = resp.text
+    if output:
+        output.write_text(text)
+        rprint(f"[green]Wrote {output}[/green]")
+    else:
+        if format == "md":
+            rprint(Markdown(text))
+        else:
+            typer.echo(text)
+
+
+@app.command("export")
+def export_cmd(
+    interview_id: str,
+    output: Path = typer.Option(Path("./transcripts.zip"), "--output", "-o"),
+) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        resp = c.get_raw(f"/v1/interviews/{interview_id}/export/transcripts")
+    output.write_bytes(resp.content)
+    rprint(f"[green]Saved ZIP to {output}[/green]")

ontora_cli-0.1.0/ontora_cli/commands/webhooks.py

@@ -0,0 +1,90 @@
+"""Webhook commands."""
+
+from __future__ import annotations
+
+import typer
+from rich import print as rprint
+
+from ontora_cli.client import OntoraClient
+from ontora_cli.config import load_config, require_api_key, require_workspace
+from ontora_cli.formatters import print_webhooks
+
+app = typer.Typer(help="Outbound webhook endpoints.")
+
+
+@app.command("list")
+def list_cmd(workspace: str | None = typer.Option(None, "--workspace", "-w")) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    ws = require_workspace(cfg, workspace)
+    with OntoraClient(cfg, key) as c:
+        data = c.get("/v1/webhook-endpoints", params={"workspace_id": ws})
+    print_webhooks(data or [])
+
+
+@app.command("add")
+def add_cmd(
+    url: str = typer.Argument(...),
+    events: str = typer.Option("", "--events", help="Comma-separated event types. Empty = all."),
+    description: str | None = typer.Option(None, "--description"),
+    workspace: str | None = typer.Option(None, "--workspace", "-w"),
+) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    ws = require_workspace(cfg, workspace)
+    event_list = [e.strip() for e in events.split(",") if e.strip()]
+    with OntoraClient(cfg, key) as c:
+        resp = c.post(
+            "/v1/webhook-endpoints",
+            json_body={
+                "workspace_id": ws,
+                "url": url,
+                "events": event_list,
+                "description": description,
+            },
+        )
+    rprint(f"[green]Created endpoint[/green] {resp['id']}")
+    rprint(f"[bold yellow]Signing secret (save now, not shown again):[/bold yellow] {resp['secret']}")
+
+
+@app.command("test")
+def test_cmd(endpoint_id: str) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        resp = c.post(f"/v1/webhook-endpoints/{endpoint_id}/test")
+    rprint(f"[green]Enqueued {resp.get('deliveries_enqueued', 0)} test delivery(ies)[/green]")
+
+
+@app.command("remove")
+def remove_cmd(endpoint_id: str) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        c.delete(f"/v1/webhook-endpoints/{endpoint_id}")
+    rprint("[yellow]Removed.[/yellow]")
+
+
+@app.command("deliveries")
+def deliveries_cmd(endpoint_id: str, limit: int = typer.Option(25, "--limit", "-n")) -> None:
+    cfg = load_config()
+    key = require_api_key(cfg)
+    with OntoraClient(cfg, key) as c:
+        data = c.get(f"/v1/webhook-endpoints/{endpoint_id}/deliveries", params={"limit": limit})
+    from rich.table import Table
+    from rich.console import Console
+    table = Table(title="Deliveries")
+    table.add_column("Event")
+    table.add_column("Status")
+    table.add_column("Attempts")
+    table.add_column("Response")
+    table.add_column("Created")
+    for d in data or []:
+        table.add_row(
+            d.get("event_type", ""),
+            str(d.get("status", "")),
+            str(d.get("attempts", 0)),
+            str(d.get("response_status") or "—"),
+            str(d.get("created_at", ""))[:19],
+        )
+    Console().print(table)

ontora_cli-0.1.0/ontora_cli/config.py

@@ -0,0 +1,72 @@
+"""CLI config: API key + base URL + workspace, loaded from env vars or `~/.ontora/config.yaml`."""
+
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+from pathlib import Path
+
+import yaml
+
+DEFAULT_BASE_URL = "https://api.ontora.com"
+CONFIG_PATH = Path.home() / ".ontora" / "config.yaml"
+
+
+@dataclass
+class CliConfig:
+    api_key: str | None
+    base_url: str
+    workspace_id: str | None
+
+
+def _load_file() -> dict:
+    if not CONFIG_PATH.exists():
+        return {}
+    try:
+        with CONFIG_PATH.open("r") as f:
+            data = yaml.safe_load(f) or {}
+            return data if isinstance(data, dict) else {}
+    except (OSError, yaml.YAMLError):
+        return {}
+
+
+def load_config() -> CliConfig:
+    file_cfg = _load_file()
+    return CliConfig(
+        api_key=os.environ.get("ONTORA_API_KEY") or file_cfg.get("api_key"),
+        base_url=os.environ.get("ONTORA_BASE_URL") or file_cfg.get("base_url") or DEFAULT_BASE_URL,
+        workspace_id=os.environ.get("ONTORA_WORKSPACE_ID") or file_cfg.get("workspace_id"),
+    )
+
+
+def save_config(*, api_key: str | None = None, base_url: str | None = None, workspace_id: str | None = None) -> None:
+    current = _load_file()
+    if api_key is not None:
+        current["api_key"] = api_key
+    if base_url is not None:
+        current["base_url"] = base_url
+    if workspace_id is not None:
+        current["workspace_id"] = workspace_id
+    CONFIG_PATH.parent.mkdir(parents=True, exist_ok=True)
+    with CONFIG_PATH.open("w") as f:
+        yaml.safe_dump(current, f)
+    # Restrict to owner-read (best-effort)
+    try:
+        CONFIG_PATH.chmod(0o600)
+    except OSError:
+        pass
+
+
+def require_api_key(cfg: CliConfig) -> str:
+    if not cfg.api_key:
+        raise RuntimeError("No API key configured. Run `ontora auth login` or set ONTORA_API_KEY.")
+    return cfg.api_key
+
+
+def require_workspace(cfg: CliConfig, cli_override: str | None) -> str:
+    ws = cli_override or cfg.workspace_id
+    if not ws:
+        raise RuntimeError(
+            "No workspace ID configured. Set ONTORA_WORKSPACE_ID or pass --workspace."
+        )
+    return ws

ontora_cli-0.1.0/ontora_cli/formatters.py

@@ -0,0 +1,84 @@
+"""Rendering helpers for rich output."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from rich.console import Console
+from rich.table import Table
+
+console = Console()
+
+
+def print_campaigns(campaigns: list[dict[str, Any]]) -> None:
+    table = Table(title="Campaigns")
+    table.add_column("ID", style="dim")
+    table.add_column("Name")
+    table.add_column("Status")
+    table.add_column("Progress")
+    table.add_column("Updated")
+    for c in campaigns:
+        completed = c.get("completed_count", 0) or 0
+        total = c.get("contact_count", 0) or 0
+        prog = f"{completed}/{total}"
+        table.add_row(
+            str(c.get("id", ""))[:8],
+            c.get("name", ""),
+            str(c.get("status", "")),
+            prog,
+            str(c.get("updated_at", ""))[:16],
+        )
+    console.print(table)
+
+
+def print_contacts(contacts: list[dict[str, Any]]) -> None:
+    table = Table(title="Contacts")
+    table.add_column("ID", style="dim")
+    table.add_column("Name")
+    table.add_column("Email")
+    table.add_column("Dept")
+    table.add_column("Status")
+    for c in contacts:
+        table.add_row(
+            str(c.get("id", ""))[:8],
+            c.get("name", ""),
+            c.get("email", "") or "",
+            c.get("department", "") or "",
+            str(c.get("status", "")),
+        )
+    console.print(table)
+
+
+def print_transcripts(convs: list[dict[str, Any]]) -> None:
+    table = Table(title="Transcripts")
+    table.add_column("ID", style="dim")
+    table.add_column("Contact")
+    table.add_column("Status")
+    table.add_column("Duration")
+    table.add_column("Summary")
+    for c in convs:
+        table.add_row(
+            str(c.get("id", ""))[:8],
+            c.get("contact_name", "") or "",
+            str(c.get("status", "")),
+            f"{c.get('duration_minutes') or '—'} min",
+            (c.get("summary") or "")[:60],
+        )
+    console.print(table)
+
+
+def print_webhooks(hooks: list[dict[str, Any]]) -> None:
+    table = Table(title="Webhooks")
+    table.add_column("ID", style="dim")
+    table.add_column("URL")
+    table.add_column("Events")
+    table.add_column("Active")
+    for h in hooks:
+        events = ", ".join(h.get("events") or []) or "*all*"
+        table.add_row(
+            str(h.get("id", ""))[:8],
+            h.get("url", ""),
+            events,
+            "yes" if h.get("active") else "no",
+        )
+    console.print(table)

ontora_cli-0.1.0/ontora_cli/main.py

@@ -0,0 +1,70 @@
+"""Ontora CLI entry point."""
+
+from __future__ import annotations
+
+import sys
+
+import httpx
+import typer
+from rich import print as rprint
+
+from ontora_cli import __version__
+from ontora_cli.client import ApiError
+from ontora_cli.commands import auth, campaigns, contacts, query, reports, transcripts, webhooks
+
+app = typer.Typer(
+    name="ontora",
+    help="Ontora CLI — manage interview campaigns, transcripts, and reports.",
+    no_args_is_help=True,
+)
+
+app.add_typer(auth.app, name="auth")
+app.add_typer(campaigns.app, name="campaigns")
+app.add_typer(contacts.app, name="contacts")
+app.add_typer(transcripts.app, name="transcripts")
+app.add_typer(reports.app, name="reports")
+app.add_typer(webhooks.app, name="webhooks")
+app.add_typer(query.app, name="query")
+
+
+def _version_callback(value: bool) -> None:
+    if value:
+        rprint(f"ontora-cli {__version__}")
+        raise typer.Exit()
+
+
+@app.callback()
+def root(
+    version: bool = typer.Option(
+        False,
+        "--version",
+        callback=_version_callback,
+        is_eager=True,
+        help="Print the CLI version and exit.",
+    ),
+) -> None:
+    """Manage interview campaigns, transcripts, and reports."""
+
+
+@app.command()
+def version() -> None:
+    """Print the CLI version."""
+    rprint(f"ontora-cli {__version__}")
+
+
+def _main() -> None:
+    try:
+        app()
+    except ApiError as e:
+        rprint(f"[red]API error ({e.status}):[/red] {e.detail}")
+        sys.exit(1)
+    except httpx.RequestError as e:
+        rprint(f"[red]Network error:[/red] {e}")
+        sys.exit(1)
+    except RuntimeError as e:
+        rprint(f"[red]Error:[/red] {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    _main()

ontora_cli-0.1.0/ontora_cli/schemas.py

@@ -0,0 +1,46 @@
+"""YAML config schemas for campaign-as-code."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, Field
+
+
+class QuestionYaml(BaseModel):
+    text: str
+    required: bool = False
+
+
+class TopicYaml(BaseModel):
+    name: str
+    goal: str | None = None
+    priority: str = "required"  # required | important | optional
+    success_threshold: str | None = None
+    sub_topics: list[str] = Field(default_factory=list)
+    questions: list[QuestionYaml] = Field(default_factory=list)
+
+
+class ContactYaml(BaseModel):
+    name: str | None = None
+    email: str | None = None
+    phone: str | None = None
+    job_title: str | None = None
+    department: str | None = None
+    seniority_level: int | None = None
+    file: str | None = None  # Path to CSV for bulk contacts
+
+
+class CampaignYaml(BaseModel):
+    name: str
+    goal: str
+    description: str | None = None
+    channel: str = "in_app_chat"
+    duration_minutes: int = 30
+    completion_threshold: float = 80.0
+    interview_context_for_employee: str | None = None
+    success_criteria: str | None = None
+    agent_behavior: str | None = None
+    welcome_screen: str | None = None
+    closing_message: str | None = None
+    timezone: str = "UTC"
+    topics: list[TopicYaml] = Field(default_factory=list)
+    contacts: list[ContactYaml] = Field(default_factory=list)

ontora_cli-0.1.0/ontora_cli.egg-info/PKG-INFO

@@ -0,0 +1,118 @@
+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>
+```

ontora_cli-0.1.0/ontora_cli.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+README.md
+pyproject.toml
+ontora_cli/__init__.py
+ontora_cli/client.py
+ontora_cli/config.py
+ontora_cli/formatters.py
+ontora_cli/main.py
+ontora_cli/schemas.py
+ontora_cli.egg-info/PKG-INFO
+ontora_cli.egg-info/SOURCES.txt
+ontora_cli.egg-info/dependency_links.txt
+ontora_cli.egg-info/entry_points.txt
+ontora_cli.egg-info/requires.txt
+ontora_cli.egg-info/top_level.txt
+ontora_cli/commands/__init__.py
+ontora_cli/commands/auth.py
+ontora_cli/commands/campaigns.py
+ontora_cli/commands/contacts.py
+ontora_cli/commands/query.py
+ontora_cli/commands/reports.py
+ontora_cli/commands/transcripts.py
+ontora_cli/commands/webhooks.py

ontora_cli-0.1.0/ontora_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ontora_cli-0.1.0/ontora_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ontora = ontora_cli.main:_main

ontora_cli-0.1.0/ontora_cli.egg-info/requires.txt

@@ -0,0 +1,5 @@
+typer>=0.12.0
+httpx>=0.27.0
+rich>=13.7.0
+pyyaml>=6.0
+pydantic>=2.6.0

ontora_cli-0.1.0/ontora_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+ontora_cli

ontora_cli-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ontora-cli"
+version = "0.1.0"
+description = "Ontora CLI — manage interview campaigns, transcripts, reports, and webhooks from the terminal."
+readme = "README.md"
+requires-python = ">=3.11"
+authors = [{ name = "Ontora" }]
+license = "LicenseRef-Proprietary"
+keywords = ["ontora", "interviews", "research", "synthesis", "cli"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "typer>=0.12.0",
+    "httpx>=0.27.0",
+    "rich>=13.7.0",
+    "pyyaml>=6.0",
+    "pydantic>=2.6.0",
+]
+
+[project.scripts]
+ontora = "ontora_cli.main:_main"
+
+[project.urls]
+Documentation = "https://docs.ontora.com/cli/install"
+API = "https://docs.ontora.com/api-reference/introduction"
+Homepage = "https://docs.ontora.com"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["ontora_cli*"]

ontora_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+