The CLI is built around persona-grounded research modes:

oriyn research ab-test --question "Which onboarding offer is clearer?" --a "Free trial" --b "Freemium tier"

It auto-resolves the product from a nearby oriyn.json, streams progress as JSONL when piped (or shows a spinner in a TTY), and prints a structured research result with participant summaries.

Why oriyn

• Research before you build. Run A/B research, Delphi rounds, experiments, or playtests against synthesized personas before you build the variant.
• Agent-native. Non-TTY → JSONL. Designed for Claude Code, Codex, CI, and shell pipelines from day one.
• Cross-provider. Personas are built from your product analytics, session replays, and payments — not from a single tool's view.
• Local-first auth. OAuth 2.1 + PKCE direct to your browser. Tokens at ~/.config/oriyn/credentials.json (0600). No keychain, no daemons.
• Honest output. No telemetry in dev or CI. ORIYN_TELEMETRY=off kills it everywhere else.

Install

# npm
npm i -g oriyn

# bun
bun add -g oriyn

# one-liner (falls back to a precompiled binary if Bun isn't installed)
curl -fsSL https://oriyn.ai/install.sh | bash

The npm/bun install requires Bun ≥ 1.2 at runtime. The curl installer ships precompiled standalone binaries for macOS and Linux (x64 + arm64) — no runtime needed.

Quickstart

oriyn auth login                            # browser PKCE
cd <your repo>
oriyn link                                  # interactive picker → oriyn.json
oriyn research modes                        # see available research modes
oriyn research ab-test --question "<question>" --a "<variant A>" --b "<variant B>"

oriyn.json lives at the project root and is shared with your team. The CLI walks up from cwd to find it (just like package.json), so monorepos with multiple linked products work out of the box.

Commands

oriyn auth login [--no-browser]      Log in via browser (OAuth 2.1 + PKCE)
oriyn auth logout                    Forget stored credentials
oriyn auth whoami                    Show the logged-in account
oriyn auth status                    Token validity + expiry

oriyn link [--product <id>]          Link a product → writes oriyn.json
oriyn unlink                         Remove oriyn.json from cwd

oriyn products                       List products in the org
oriyn personas                       List behavioral personas
oriyn personas <id>                  Persona detail (profile + facts)
oriyn patterns                       Mined hypotheses + bottlenecks
oriyn research modes                 List research modes
oriyn research list                  List research runs
oriyn research ab-test               Compare two variants
oriyn research delphi                Run a multi-round persona workshop
oriyn research experiment            Simulate 100, 500, or 1000 agents
oriyn research playtest              Run a task-based playtest

oriyn sync                           Idempotent synthesize → enrich
oriyn status                         One-screen diagnostic
oriyn config [key] [value]           Show or update CLI config
oriyn open [resource]                Open the web app for the linked product
oriyn upgrade                        Upgrade to the latest version
oriyn completion <bash|zsh|fish>     Print shell completion script

Run oriyn <command> --help for full flags on any command.

Agents & CI

For sandboxed agents (Claude Code, Codex, GitHub Actions, etc.), set one env var and commit oriyn.json:

export ORIYN_ACCESS_TOKEN=<token>           # from app.oriyn.ai → Settings
oriyn research experiment --question "<question>" --a "<positioning A>" --b "<positioning B>" --agents 100

Install the Oriyn Agent Skill so Claude Code, Codex, Cursor, and other agents know when to reach for the CLI:

npx skills add oriyn-ai/skills

The CLI infers JSONL mode from a non-TTY stdout. Each line is one event:

{"type":"step","name":"resolve-product","ts":"…"}
{"type":"progress","message":"status: running","ts":"…"}
{"type":"result","data":{"kind":"experiment","status":"succeeded","output_summary":{…}}}

Force the mode explicitly with --human or --json if you need to override TTY detection.

Exit codes: 0 ok · 2 api · 3 auth · 4 network · 5 permission · 1 other.

Configuration

| Path | Purpose | | ----------------------------------- | -------------------------------------------------- | | ~/.config/oriyn/credentials.json | Auth tokens (mode 0600) | | ~/.config/oriyn/config.json | CLI prefs (telemetry, default product) | | <repo>/oriyn.json | Project link { orgId, productId } — commit it |

| Env var | Effect | | --------------------- | ------------------------------------------------- | | ORIYN_ACCESS_TOKEN | Skip credentials file (CI escape hatch) | | ORIYN_API_BASE | Override API base URL | | ORIYN_PRODUCT | Override the linked product | | ORIYN_ORG | Override the linked org | | ORIYN_CONFIG_DIR | Move the global config dir (useful for tests) | | ORIYN_TELEMETRY=off | Disable PostHog usage events | | NO_COLOR=1 | Disable colors | | FORCE_COLOR=1 | Force colors when piped |

Telemetry

Anonymous usage events are sent to PostHog to help us prioritize. They are:

• Off in dev (VERSION === '0.0.0-dev') and on CI (auto-detected)
• Announced with a one-line notice on first use
• Disabled instantly with ORIYN_TELEMETRY=off or oriyn config telemetry off
• Scrubbed of all bearer tokens, JWTs, and refresh tokens before send

No request bodies, no hypotheses, no persona content — only command name, exit code, and duration.

Local development

git clone https://github.com/oriyn-ai/cli.git && cd cli
bun install
bun test
bun run src/index.ts --help

| Task | Command | | --------------- | ------------------------------------ | | Run during dev | bun run src/index.ts <args> | | Unit tests | bun test | | Lint + format | bun x biome check . (--write to fix) | | Typecheck | bunx tsc --noEmit | | Build npm bundle| bun run build | | Cross-compile | bun run build:bin:all |

See AGENTS.md for the full contributor guide and architecture notes, and CONTRIBUTING.md for PR expectations.

Security

Found a vulnerability? Please do not open a public issue — email [email protected] instead. See SECURITY.md for the full policy.

License

Apache 2.0 © Pontis Inc.