Ramoira CLI

Brand schema generation and publishing for the agent web.

npm install -g ramoira

What it does

ramoira init asks you ten questions and generates a brand.schema.json in your project — a structured, machine-readable definition of your brand identity. Your own LLM key does the generation. Nothing leaves your machine.

Generation runs in fast mode by default (~20 seconds), producing the required schema sections immediately. After generation, the CLI surfaces a brand preview: personality scores, cultural tension, voice examples (approved vs rejected), and owned phrases — so you can see whether the model got your brand right before opening any file.

Once you have a schema, AI tools in your project (Cursor, Claude Code, Windsurf, v0, Lovable) read it automatically. No re-prompting every session. Consistent voice across tools, models, and collaborators.

Commands

ramoira init        Generate brand.schema.json locally (no account required)
ramoira validate    Validate schema against the Ramoira spec
ramoira publish     Publish summary to ramoira.com (free account required)
ramoira book        Generate a brand book HTML from your schema
ramoira status      Show current publication state
ramoira login       Save API token for publish and status commands

Quick start

# Tier 1 — local only, no account
npx ramoira init
npx ramoira validate

# Tier 2 — publish to ramoira.com (get a token at ramoira.com/tokens)
export RAMOIRA_TOKEN=your_token
npx ramoira publish

# Generate a brand book HTML (requires token)
npx ramoira book
# → writes <brandId>-brand-book.html. Open in browser, print to PDF.

# Check publication state
npx ramoira status

Guide for Brand Managers

If you are a brand manager running this on your own laptop (Windows or macOS) to generate a brand schema:

1. Install Node.js (Required):
   • The CLI requires Node.js to run.
   • Windows: Download the "LTS" (Long Term Support) installer from nodejs.org and run it. Follow the standard prompts.
   • macOS: Download the "LTS" macOS installer from nodejs.org and run it.
   • Note: After installing, you must restart your terminal or computer.
2. Open your terminal:
   • macOS: Press Cmd + Space, type Terminal, and hit Enter.
   • Windows: Press Win + R, type powershell, and hit Enter.
3. Get an Anthropic API key:
   • Go to console.anthropic.com and create an API key. You will need some credits to run the AI model.
4. Set the key and run the tool:
   • macOS:

     export ANTHROPIC_API_KEY=sk-ant-your-key-here
     npx ramoira init

   • Windows (PowerShell):

     $env:ANTHROPIC_API_KEY="sk-ant-your-key-here"
     npx ramoira init

   • Windows (Command Prompt):

     set ANTHROPIC_API_KEY=sk-ant-your-key-here
     npx ramoira init

   • No environment variable? Just run npx ramoira init and paste your key when prompted. It will be saved for future commands.
5. Answer the questions: The CLI will ask you 10 questions about your brand. Generation takes ~20 seconds. Once finished, it shows a brand preview and saves ramoira/brand.schema.json.

How agents consume your schema

Any agent or tool with access to your project directory reads brand.schema.json directly. For remote agents and deployed pipelines, the published summary schema at ramoira.com/brands/[slug]/schema.summary.json is publicly accessible and crawlable.

LLM key

ramoira init calls your own LLM to generate the schema. It reads ANTHROPIC_API_KEY from your environment, or prompts you for one if not set.

export ANTHROPIC_API_KEY=sk-ant-...
ramoira init

If you enter the key manually at the prompt, it is saved to ~/.ramoira/config.json so subsequent commands (book, publish) pick it up automatically — no need to export it again each session.

OpenAI-compatible providers: set OPENAI_API_KEY and OPENAI_BASE_URL.

Schema format

The schema format is an open standard. Full specification, JSON validators, and worked examples:

github.com/ramoira/brand-schema-spec

Documentation

Integration guides, field reference, and agent workflow docs:

github.com/ramoira/docs

Tiers

| | Tier 1 — Local | Tier 2 — Published | Tier 3 — Studio | |---|---|---|---| | ramoira init | ✓ | ✓ | ✓ | | ramoira validate | ✓ | ✓ | ✓ | | ramoira publish | — | ✓ | ✓ | | ramoira book | — | ✓ | ✓ | | ramoira studio | — | — | ✓ | | Account required | No | Yes (free) | Yes (paid) | | Schema stored by Ramoira | Nothing | Summary only | Full (private) | | Public URL | — | ✓ draft | ✓ certified | | LLM flywheel | — | Slow | Fast |

Testing & local development

Run the test suite:

npm test

23 unit tests covering schema validation, JSON extraction, file I/O, and publish logic.

Build the CLI:

npm run build        # compiles to dist/index.js

Run commands without a global install:

# tsx — no build needed, fastest for dev iteration
node --import tsx/esm src/index.ts init

# built dist
node dist/index.js init
node dist/index.js --help

Test the full init flow end-to-end:

export ANTHROPIC_API_KEY=sk-ant-...
node dist/index.js init
node dist/index.js validate

Test validate against a bad file:

echo '{"meta":{}}' > bad.json
node dist/index.js validate bad.json
# exits 1 with a list of errors

Test auth commands (no API required):

node dist/index.js whoami    # not logged in
node dist/index.js login     # paste any token to test storage
node dist/index.js whoami    # shows token is set
node dist/index.js logout

Point publish/status at a local backend:

export RAMOIRA_API_URL=http://localhost:3000
node dist/index.js publish
node dist/index.js status my-brand

License

MIT — the CLI and schema format are open source. Brand schemas you generate are yours entirely.