Skip to content
Scriptorium Scriptorium

CLI commands

The scriptorium CLI exposes five subcommands.

$ scriptorium --help
Usage: scriptorium [OPTIONS] COMMAND [ARGS]...


  Scriptorium: agentic operating system for scholarly writing.


Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.


Commands:
  init         Scaffold a starter MANUSCRIPT_STATE.yaml in a manuscript dir.
  install      Install scriptorium into the Claude Code plugins directory.
  list         List bundled skills with descriptions and grounding refs.
  prompt-pack  Emit bundled skill prompts as per-skill files or one concatenated file.
  validate     Validate a MANUSCRIPT_STATE.yaml file against the JSON Schema.

scriptorium install

Section titled “scriptorium install”

Install scriptorium into the Claude Code plugins directory.

Usage: scriptorium install [OPTIONS]


Options:
  --mode [dev-link|copy]  dev-link symlinks the source repo; copy installs
                          from package data. [default: copy]
  --target PATH           Install target (default: ~/.claude/plugins/scriptorium).
  --force                 Overwrite an existing install.

Use --mode dev-link when working from a clone (uv sync + dev-link). Use --mode copy when installing from a published wheel.

scriptorium validate <path>

Section titled “scriptorium validate <path>”

Validate a MANUSCRIPT_STATE.yaml file against the JSON Schema (Draft 2020-12). Prints per-field errors and exits non-zero on failure.

Terminal window
scriptorium validate MANUSCRIPT_STATE.yaml

scriptorium prompt-pack

Section titled “scriptorium prompt-pack”

Emit the bundled skill prompts so non-Claude-Code agents can use them. The default is one file per skill plus a README.md manifest, written to a directory; --single-file preserves the older single-document behavior. See the how-to for the recommended flow.

Usage: scriptorium prompt-pack [OPTIONS]


Options:
  -o, --output PATH  Write the prompt pack to this path. If the path is (or
                     looks like) a directory, one file per skill plus a
                     README.md manifest is written there. Otherwise a single
                     concatenated file is written. Defaults to stdout when
                     omitted.
  --single-file      Force single-file concatenated output even when --output
                     looks like a directory.
  --prefix TEXT      Prefix prepended to each per-skill filename (e.g.
                     --prefix scriptorium- emits scriptorium-citation-audit.md).
                     Default: empty. Has no effect with --single-file.

scriptorium list

Section titled “scriptorium list”

List bundled skills with descriptions and grounding references (the knowledge documents each skill grounds in).

scriptorium init <manuscript-dir>

Section titled “scriptorium init <manuscript-dir>”

Scaffold a starter MANUSCRIPT_STATE.yaml in a directory. Refuses to overwrite without --force.

Usage: scriptorium init [OPTIONS] MANUSCRIPT_DIR


Options:
  --force  Overwrite an existing MANUSCRIPT_STATE.yaml.

A conversational counterpart — the init skill — is planned for v0.2 (issue #28). It walks an author through populating the file rather than copying a template.

Section titled “Related”