grimoire-wizard 0.3.0

package/examples/demo.yaml

@@ -0,0 +1,112 @@
+meta:
+  name: "Grimoire Component Demo"
+  description: "Showcasing all 10 step types, groups, and theming"
+
+theme:
+  tokens:
+    primary: "#89b4fa"
+    success: "#a6e3a1"
+    error: "#f38ba8"
+    warning: "#fab387"
+    info: "#74c7ec"
+    muted: "#6c7086"
+    accent: "#cba6f7"
+  icons:
+    step: "●"
+    stepDone: "✔"
+    stepPending: "○"
+    pointer: "❯"
+
+steps:
+  - id: name
+    type: text
+    group: "Text Inputs"
+    message: "What is your name?"
+    placeholder: "John Doe"
+    validate:
+      - rule: required
+      - rule: minLength
+        value: 2
+
+  - id: bio
+    type: editor
+    group: "Text Inputs"
+    message: "Write a short bio (opens editor)"
+    required: false
+
+  - id: project-dir
+    type: path
+    group: "Text Inputs"
+    message: "Project directory"
+    placeholder: "./my-project"
+    default: "."
+
+  - id: secret
+    type: password
+    group: "Text Inputs"
+    message: "Enter a secret key"
+    validate:
+      - rule: minLength
+        value: 4
+        message: "At least 4 characters"
+
+  - id: framework
+    type: select
+    group: "Selections"
+    message: "Pick a framework"
+    options:
+      - { value: react, label: "React" }
+      - { value: vue, label: "Vue" }
+      - { value: svelte, label: "Svelte" }
+      - { value: angular, label: "Angular", hint: "Enterprise-ready" }
+
+  - id: tools
+    type: multiselect
+    group: "Selections"
+    message: "Choose your tools"
+    options:
+      - { value: eslint, label: "ESLint", hint: "Linting" }
+      - { value: prettier, label: "Prettier", hint: "Formatting" }
+      - { value: vitest, label: "Vitest", hint: "Testing" }
+      - { value: husky, label: "Husky", hint: "Git hooks" }
+    min: 1
+    max: 3
+
+  - id: language
+    type: search
+    group: "Selections"
+    message: "Search for a language"
+    options:
+      - { value: typescript, label: "TypeScript" }
+      - { value: javascript, label: "JavaScript" }
+      - { value: python, label: "Python" }
+      - { value: go, label: "Go" }
+      - { value: rust, label: "Rust" }
+      - { value: java, label: "Java" }
+      - { value: csharp, label: "C#" }
+      - { value: ruby, label: "Ruby" }
+
+  - id: dark-mode
+    type: toggle
+    group: "Toggles & Numbers"
+    message: "Enable dark mode?"
+    active: "Dark"
+    inactive: "Light"
+    default: true
+
+  - id: port
+    type: number
+    group: "Toggles & Numbers"
+    message: "Dev server port"
+    default: 3000
+    min: 1024
+    max: 65535
+
+  - id: proceed
+    type: confirm
+    group: "Confirmation"
+    message: "Proceed with these settings?"
+    next: __done__
+
+output:
+  format: json

package/examples/ebay-mcp-setup.yaml

@@ -0,0 +1,171 @@
+meta:
+  name: "eBay MCP Setup"
+  description: "Interactive setup wizard for eBay MCP server configuration"
+
+theme:
+  tokens:
+    primary: "#0064d2"
+    success: "#4caf50"
+    error: "#e53935"
+    warning: "#ff9800"
+    info: "#2196f3"
+    muted: "#757575"
+    accent: "#7c3aed"
+
+checks:
+  - name: "Node.js installed"
+    run: "node --version"
+    message: "Node.js >= 18 is required"
+
+steps:
+  - id: first-time
+    type: confirm
+    group: "Getting Started"
+    message: "Is this your first time setting up eBay Developer credentials?"
+    default: true
+
+  - id: runame-help
+    type: confirm
+    group: "Getting Started"
+    message: "Need help understanding RuName (Redirect URI)?"
+    default: false
+    when:
+      field: first-time
+      equals: true
+
+  - id: environment
+    type: select
+    group: "Environment"
+    message: "Select target environment"
+    options:
+      - { value: sandbox, label: "Sandbox (Development & Testing)" }
+      - { value: production, label: "Production (Live Trading)" }
+    default: sandbox
+
+  - id: client-id
+    type: text
+    group: "Credentials"
+    message: "Enter your eBay App ID (Client ID)"
+    placeholder: "YourApp-SBX-xxxxxxxx-xxxxxxxx"
+    validate:
+      - rule: required
+        message: "Client ID is required"
+
+  - id: client-secret
+    type: password
+    group: "Credentials"
+    message: "Enter your eBay Cert ID (Client Secret)"
+    validate:
+      - rule: required
+        message: "Client Secret is required"
+
+  - id: redirect-uri
+    type: text
+    group: "Credentials"
+    message: "Enter your RuName (Redirect URI)"
+    default: "http://localhost:3000/oauth/callback"
+    validate:
+      - rule: required
+      - rule: pattern
+        value: "^https?://"
+        message: "Must be a valid URL starting with http:// or https://"
+
+  - id: marketplace
+    type: search
+    group: "Marketplace"
+    message: "Search for your eBay marketplace"
+    options:
+      - { value: EBAY_US, label: "United States (EBAY_US)" }
+      - { value: EBAY_GB, label: "United Kingdom (EBAY_GB)" }
+      - { value: EBAY_DE, label: "Germany (EBAY_DE)" }
+      - { value: EBAY_AU, label: "Australia (EBAY_AU)" }
+      - { value: EBAY_FR, label: "France (EBAY_FR)" }
+      - { value: EBAY_IT, label: "Italy (EBAY_IT)" }
+      - { value: EBAY_ES, label: "Spain (EBAY_ES)" }
+      - { value: EBAY_CA, label: "Canada (EBAY_CA)" }
+    default: EBAY_US
+
+  - id: scopes
+    type: multiselect
+    group: "OAuth Scopes"
+    message: "Select OAuth scope categories"
+    options:
+      - { value: inventory, label: "Inventory", hint: "Manage listings and inventory" }
+      - { value: orders, label: "Orders", hint: "View and manage orders" }
+      - { value: account, label: "Account", hint: "Account settings and policies" }
+      - { value: analytics, label: "Analytics", hint: "Traffic and sales reports" }
+      - { value: marketing, label: "Marketing", hint: "Promotions and campaigns" }
+      - { value: finance, label: "Finance", hint: "Payouts and transactions" }
+      - { value: reputation, label: "Reputation", hint: "Seller feedback and ratings" }
+      - { value: commerce, label: "Commerce Services", hint: "Taxonomy and catalog APIs" }
+    min: 1
+
+  - id: view-scopes
+    type: confirm
+    group: "OAuth Scopes"
+    message: "Would you like to review the selected scope details?"
+    default: false
+
+  - id: token-method
+    type: select
+    group: "Authentication"
+    message: "How would you like to obtain your OAuth token?"
+    options:
+      - { value: interactive, label: "Interactive OAuth Flow", hint: "Recommended" }
+      - { value: manual, label: "Manual OAuth Flow", hint: "Get token yourself" }
+      - { value: existing, label: "I already have a refresh token" }
+      - { value: skip, label: "Skip (configure later)" }
+    routes:
+      existing: refresh-token
+      skip: configure-clients
+
+  - id: refresh-token
+    type: text
+    group: "Authentication"
+    message: "Enter your refresh token"
+    validate:
+      - rule: required
+      - rule: pattern
+        value: "^v\\^1\\.1#"
+        message: "Token should start with v^1.1#"
+
+  - id: configure-clients
+    type: multiselect
+    group: "MCP Clients"
+    message: "Select MCP clients to configure"
+    options:
+      - { value: claude-desktop, label: "Claude Desktop" }
+      - { value: cursor, label: "Cursor" }
+      - { value: cline, label: "Cline (VS Code)" }
+      - { value: windsurf, label: "Windsurf" }
+      - { value: zed, label: "Zed" }
+      - { value: continue, label: "Continue.dev" }
+      - { value: roo-code, label: "Roo Code" }
+      - { value: claude-code, label: "Claude Code CLI" }
+      - { value: amazon-q, label: "Amazon Q" }
+
+  - id: docker-setup
+    type: confirm
+    group: "Docker"
+    message: "Generate Docker configuration?"
+    default: false
+
+  - id: confirm-setup
+    type: confirm
+    group: "Review"
+    message: "Save this configuration and complete setup?"
+    default: true
+    next: __done__
+
+output:
+  format: env
+  path: .env
+
+actions:
+  - name: "Write environment file"
+    run: "echo 'Configuration saved successfully'"
+  - name: "Generate Docker files"
+    run: "echo 'Docker configuration generated'"
+    when:
+      field: docker-setup
+      equals: true

package/examples/extended.yaml

@@ -0,0 +1,34 @@
+extends: ./base.yaml
+
+meta:
+  name: "Extended Project Wizard"
+  description: "Extends base config with additional steps"
+
+steps:
+  - id: name
+    type: text
+    message: "Project name?"
+    validate:
+      - rule: required
+
+  - id: language
+    type: select
+    message: "Language?"
+    options:
+      - { value: typescript, label: "TypeScript" }
+      - { value: javascript, label: "JavaScript" }
+      - { value: python, label: "Python" }
+
+  - id: description
+    type: text
+    message: "Description?"
+    required: false
+
+  - id: confirm
+    type: confirm
+    message: "Create project?"
+    next: __done__
+
+output:
+  format: yaml
+  path: project-config.yaml

package/examples/themed.yaml

@@ -0,0 +1,92 @@
+meta:
+  name: "Catppuccin Setup"
+  description: "A beautifully themed wizard"
+
+theme:
+  tokens:
+    primary: "#89b4fa"
+    success: "#a6e3a1"
+    error: "#f38ba8"
+    warning: "#fab387"
+    info: "#74c7ec"
+    muted: "#6c7086"
+    accent: "#cba6f7"
+  icons:
+    step: "\u2B24"
+    stepDone: "\u2714"
+    stepPending: "\u25EF"
+    pointer: "\u276F"
+
+steps:
+  - id: username
+    type: text
+    message: "Choose a username"
+    validate:
+      - rule: required
+      - rule: minLength
+        value: 3
+      - rule: maxLength
+        value: 20
+      - rule: pattern
+        value: "^[a-zA-Z][a-zA-Z0-9_]*$"
+        message: "Letters, numbers, underscores only. Must start with a letter."
+
+  - id: email
+    type: text
+    message: "Your email address"
+    validate:
+      - rule: required
+      - rule: pattern
+        value: "^[^@]+@[^@]+\\.[^@]+$"
+        message: "Enter a valid email address"
+
+  - id: role
+    type: select
+    message: "Select your role"
+    options:
+      - { value: developer, label: "Developer" }
+      - { value: designer, label: "Designer" }
+      - { value: manager, label: "Project Manager" }
+      - { value: devops, label: "DevOps Engineer" }
+
+  - id: experience
+    type: number
+    message: "Years of experience"
+    min: 0
+    max: 50
+    default: 3
+
+  - id: interests
+    type: multiselect
+    message: "Areas of interest"
+    options:
+      - { value: frontend, label: "Frontend Development" }
+      - { value: backend, label: "Backend Development" }
+      - { value: mobile, label: "Mobile Development" }
+      - { value: ai, label: "AI / Machine Learning" }
+      - { value: devops, label: "DevOps / Infrastructure" }
+      - { value: security, label: "Security" }
+    min: 1
+    max: 3
+
+  - id: newsletter
+    type: confirm
+    message: "Subscribe to our newsletter?"
+    default: true
+
+  - id: password
+    type: password
+    message: "Set a password"
+    validate:
+      - rule: minLength
+        value: 8
+        message: "Password must be at least 8 characters"
+
+  - id: confirm
+    type: confirm
+    message: "Create your account?"
+    next: __done__
+
+output:
+  format: json
+  path: "account.json"

package/examples/with-checks.yaml

@@ -0,0 +1,34 @@
+meta:
+  name: "Deployment Wizard"
+  description: "Deploy with pre-flight safety checks"
+
+checks:
+  - name: Node.js installed
+    run: node --version
+    message: "Node.js is required. Install from https://nodejs.org"
+  - name: Git available
+    run: git --version
+    message: "Git is required. Install from https://git-scm.com"
+
+steps:
+  - id: environment
+    type: select
+    message: "Deploy to which environment?"
+    options:
+      - { value: staging, label: "Staging" }
+      - { value: production, label: "Production" }
+
+  - id: version
+    type: text
+    message: "Version tag?"
+    default: "latest"
+    validate:
+      - rule: required
+
+  - id: confirm
+    type: confirm
+    message: "Deploy now?"
+    next: __done__
+
+output:
+  format: json

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "grimoire-wizard",
+  "version": "0.3.0",
+  "description": "Config-driven CLI wizard framework. Define interactive terminal wizards in YAML/JSON with back-navigation, conditional branching, theming, and structured output.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "bin": {
+    "grimoire": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "examples",
+    "schema",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src/",
+    "schema:generate": "echo \"Schema is hand-maintained\"",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "cli",
+    "wizard",
+    "tui",
+    "terminal",
+    "prompt",
+    "interactive",
+    "yaml",
+    "json",
+    "config-driven",
+    "back-navigation",
+    "conditional",
+    "theming",
+    "inquirer",
+    "clack"
+  ],
+  "author": "Yosef Hayim (https://github.com/YosefHayim)",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^7.0.0",
+    "chalk": "^5.4.0",
+    "commander": "^13.0.0",
+    "cosmiconfig": "^9.0.0",
+    "figlet": "^1.10.0",
+    "gradient-string": "^3.0.0",
+    "yaml": "^2.7.0",
+    "zod": "^3.24.0"
+  },
+  "devDependencies": {
+    "@types/figlet": "^1.7.0",
+    "@types/gradient-string": "^1.1.6",
+    "@types/node": "^22.0.0",
+    "tsup": "^8.4.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  }
+}