Loracle CLI

Publishes your Storybook to Loracle so your AI tools always have up-to-date component context.

Documentation

👉 Read the Loracle CLI docs

Requirements

• Node.js 18+
• Storybook 7+
• A Loracle API key — get one at getloracle.com

Usage

npx @loracle-js/cli publish <storybook-url> --version <semver>

Example:

LORACLE_API_KEY=your_api_key npx @loracle-js/cli publish https://storybook.example.com --version 1.2.0

Options

| Option | Description | |---|---| | -v, --version | Semantic version for this build (required) | | --dry-run | Validate without uploading |

Environment variables

| Variable | Description | |---|---| | LORACLE_API_KEY | Your Loracle API key (required) |

CI

GitHub Actions

- name: Install Playwright browsers
  run: npx playwright install chromium --with-deps

- name: Publish to Loracle
  run: npx @loracle-js/cli publish ${{ vars.STORYBOOK_URL }} --version ${{ github.ref_name }}
  env:
    LORACLE_API_KEY: ${{ secrets.LORACLE_API_KEY }}

GitHub Actions (official Playwright image)

container:
  image: mcr.microsoft.com/playwright:latest

steps:
  - name: Publish to Loracle
    run: npx @loracle-js/cli publish ${{ vars.STORYBOOK_URL }} --version ${{ github.ref_name }}
    env:
      LORACLE_API_KEY: ${{ secrets.LORACLE_API_KEY }}