MuseRock CLI

MuseRock CLI is a creative workflow companion for writers, storytellers, and creators. It provides a structured approach to creative work through the Prime-Cloister-Divergence-Reflection cycle.

Installation

Global Installation

npm install -g @muserock/cli

Local Installation

npm install @muserock/cli

Requirements

• Node.js 18.0.0 or higher

Quick Start

After installation, you can start using the MuseRock CLI:

muserock --help

Commands

prime - Create or Edit a Prime Brief

The Prime Brief is the foundation of your creative project. It defines your intent, constraints, and references.

Usage:

muserock prime

Options:

| Option | Description | |--------|-------------| | -e, --edit | Edit the prime brief in your default editor | | -f, --file <file> | Specify the file name to use |

Examples:

# Interactive mode
muserock prime

# Editor mode
muserock prime -e

# Use a custom file
muserock prime -f my-brief.json

cloister - Enter Cloister Mode

Cloister mode is for deep reflection and focused work. It helps you dive deeper into your ideas.

Usage:

muserock cloister

divergence - Generate Creative Ideas

Divergence mode helps you explore multiple creative paths and generate new ideas.

Usage:

muserock divergence

reflection - Reflect on Progress

Reflection mode helps you review your progress, document what worked, and plan next steps.

Usage:

muserock reflection

export - Export Project

Export your project to JSON, Markdown, or ZIP format.

Usage:

muserock export

Options:

| Option | Description | |--------|-------------| | -p, --project-id <id> | ID of the project to export | | -f, --format <format> | Output format: json, markdown, or zip (default: json) | | -o, --output <path> | Output file path |

Examples:

# Interactive export
muserock export

# Export specific project to JSON
muserock export -p project-123 -f json -o my-project.json

# Export to ZIP (includes all files)
muserock export -p project-123 -f zip -o my-project.zip

Export Formats:

• JSON: Complete project data as a single JSON file (web app compatible)
• Markdown: Human-readable Markdown format with all project content
• ZIP: Complete package including JSON, Markdown, and individual files for elements, notes, etc.

import - Import Project

Import a project from JSON, ZIP, or Markdown file.

Usage:

muserock import

Options:

| Option | Description | |--------|-------------| | -f, --file <file> | Path to the file to import | | -n, --name <name> | Custom name for the imported project |

Examples:

# Interactive import
muserock import

# Import a specific file
muserock import -f my-project.json

# Import with custom name
muserock import -f my-project.zip -n "New Project Name"

Import Formats:

• JSON: Import from a previously exported JSON file
• ZIP: Import from a ZIP package (must contain project.json)
• Markdown: Creates a new project with basic structure

Workflow

The MuseRock workflow follows a four-stage cycle:

1. Prime - Define your intent, constraints, and references
2. Cloister - Deep dive into focused work
3. Divergence - Explore multiple creative paths
4. Reflection - Review progress and plan next steps

Project Storage

Projects are stored in your home directory under ~/.muserock/projects/. Each project is saved as a JSON file.

Development

Building

npm run build

Development Mode

npm run dev

Testing

npm test

Watch Mode

npm run test:watch

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT