refira-cli 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,153 @@
+# Refira CLI
+
+A command-line tool and deterministic AI Agent Harness for designing and previewing standalone HTML5 and Tailwind CSS prototypes in Refira workspaces.
+
+Refira CLI enables autonomous coding agents (such as Google Antigravity, Claude Code, Cursor Agent, and Aider) and developers to interact directly with the Refira canvas, fetch design tokens, scaffold clean templates, and validate markup before publishing.
+
+---
+
+## Overview
+
+Refira is an AI design workspace that maintains persistent design context and renders prototypes inside sandboxed iframes. Refira CLI serves two purposes:
+1. **Developer & Agent CLI:** Manage sessions, pull design tokens, and push live page markup.
+2. **Deterministic Agent Harness:** Automatically lint markup with `htmlparser2` to enforce design consistency and prevent broken prototype states before code reaches the backend.
+
+---
+
+## Installation
+
+Run directly using NPX without installation:
+```bash
+npx refira-cli --help
+```
+
+Or install globally on your system:
+```bash
+npm install --global refira-cli
+```
+
+Verify installation:
+```bash
+refira --version
+```
+
+---
+
+## Command Reference
+
+### 1. Authentication
+
+#### `refira auth login`
+Authenticates against a Refira instance and stores credentials locally in `.refirarc` (or globally in `~/.refirarc`).
+
+```bash
+refira auth login --api-url https://api.refira.dev --api-key rfr_your_api_key
+```
+
+Options:
+- `--api-url <url>`: Refira backend API endpoint (default: `http://localhost:3001`).
+- `--api-key <key>`: Project-scoped API key with `rfr_` prefix.
+- `-g, --global`: Save credentials globally in user home directory.
+
+#### `refira auth status`
+Verifies the current session and displays project and user identifiers.
+
+```bash
+refira auth status
+```
+
+---
+
+### 2. Workspace Initialization
+
+#### `refira init`
+Connects to the project API, downloads design tokens, and deterministically generates operational guidelines for AI coding agents:
+- `AGENTS.md`: Operational instructions for Antigravity, Codex, Gemini CLI, and other agents.
+- `.cursorrules`: Rule definitions for Cursor.
+- `.agents/skills/refira/SKILL.md`: Design craftsmanship skill focusing on high-aesthetic UI execution.
+
+```bash
+refira init --project-id <project-uuid>
+```
+
+---
+
+### 3. Design Context & Tokens
+
+#### `refira context`
+Displays project design tokens (primary typography font, palette colors) and the existing page roster.
+
+```bash
+refira context
+```
+
+---
+
+### 4. Page Scaffolding
+
+#### `refira scaffold`
+Generates a standalone HTML5 starter template pre-configured with:
+- Google Fonts specified in project design tokens.
+- Tailwind CSS CDN and theme extensions.
+- Lucide Icons script.
+- Body content slot marking where agent layout markup should be placed.
+
+```bash
+refira scaffold --page checkout
+```
+
+Options:
+- `--page <slug>`: Required page slug (e.g., `checkout`, `dashboard`, `landing`).
+- `--output <path>`: Custom destination file path (default: `<slug>.html`).
+
+---
+
+### 5. Live Preview & Harness Validation
+
+#### `refira preview`
+Inspects an HTML markup file using the Refira Agent Harness. If violations are detected, execution halts with Exit Code 1 and actionable remediation instructions. If valid, the markup is streamed directly to the Refira Canvas.
+
+```bash
+refira preview checkout.html --page checkout
+```
+
+Arguments:
+- `<file>`: Path to the HTML file to inspect and preview.
+
+Options:
+- `--page <slug>`: Target page slug.
+
+---
+
+### 6. Agent Skill Installation
+
+#### `refira skill install`
+Installs the Refira design craftsmanship guide (`SKILL.md`) for AI agents.
+
+```bash
+# Local project installation (.agents/skills/refira/SKILL.md)
+refira skill install
+
+# Global installation (~/.agents/skills/refira/SKILL.md)
+refira skill install --global
+```
+
+---
+
+## Agent Harness Invariants
+
+All markup submitted via `refira preview` must conform to these strict architectural rules:
+
+| Rule | Status | Description |
+|---|---|---|
+| **Standalone HTML5 + Tailwind** | Required | Markup must be valid native HTML5 with Tailwind CSS utility classes. |
+| **No UI Frameworks** | Prohibited | React, Vue, Svelte, Angular, Solid, and JSX syntax (`className=`, `onClick={...}`, `<Component />`) are rejected. |
+| **No External / Inter-Page Navigation** | Prohibited | Prototypes run inside sandboxed iframes. Anchors (`<a href="...">`) pointing to external URLs or relative pages (e.g. `/checkout`) are rejected. Only in-page anchors (`href="#section"`) or placeholders (`href="#"`) are allowed. |
+| **No Raw Emojis in Markup** | Prohibited | Raw unicode emojis (e.g. rocket, fire, sparkles) in HTML text nodes or attributes are rejected to maintain professional aesthetic quality. Use Lucide Icons or Heroicons SVG elements instead. |
+| **Graphics & Animation Libraries** | Permitted | Standalone CDN scripts such as Three.js, GSAP, Spline Viewer, and Lucide Icons are explicitly allowed in document `<head>` or `<script>`. |
+
+---
+
+## License
+
+MIT License. Distributed as part of the Refira workspace ecosystem.

package/package.json

@@ -1,26 +1,25 @@
 {
   "name": "refira-cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Refira CLI tool and AI Agent Harness for deterministic prototype generation",
   "type": "module",
   "bin": {
     "refira": "./dist/index.js"
   },
   "main": "./dist/index.js",
-  "files": ["dist"],
+  "files": ["dist", "README.md"],
   "scripts": {
     "build": "bun build src/index.ts --outfile dist/index.js --target node",
     "prepublishOnly": "bun run build",
     "test": "vitest run",
     "type-check": "tsc --noEmit"
   },
-  "dependencies": {
-    "@refira/shared": "workspace:*",
-    "commander": "^12.1.0",
-    "htmlparser2": "^9.1.0"
-  },
+  "dependencies": {},
   "devDependencies": {
+    "@refira/shared": "workspace:*",
     "@types/node": "^20.14.0",
+    "commander": "^12.1.0",
+    "htmlparser2": "^9.1.0",
     "typescript": "^5.5.4",
     "vitest": "^2.0.5"
   }