Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@polyhedral/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@polyhedral/cli

CLI for building custom character sheet templates on Polyhedral. Edit locally in your own editor, push to the server, and preview changes live.

Install

npm install -g @polyhedral/cli

Requires Node.js 20+. Or use npx @polyhedral/cli without installing.

Quick Start

# Log in with your API key (get one from Connected Apps in your account settings)
polyhedral login

# Scaffold a new template project
polyhedral init my-sheet
cd my-sheet

# Start the live preview loop — edit, save, see it update
polyhedral dev

Commands

Command	Description
`polyhedral login`	Authenticate with your API key
`polyhedral init`	Scaffold a new template project
`polyhedral dev`	Watch file, auto-push on save, open live preview
`polyhedral push`	Validate and upload the local template
`polyhedral pull`	Download a template to a local file
`polyhedral list`	List all your custom sheet templates
`polyhedral validate`	Check a template file for syntax errors

How It Works

Templates are JSX files using the Polyhedral SDK component library. The CLI wraps the REST API to manage templates from the terminal.

The dev command is the main workflow: it pushes your template, opens the preview page, and watches for file changes. When you save, it validates and pushes automatically. The preview page uses realtime subscriptions, so it updates without a manual refresh.

Docs

Full documentation at polyhedral.co/developers/cli.

License

MIT