Command reference
This page is generated from the argument parser when the documentation site is built. The notes for other apps are in the command-line guide.
plotweaver
usage: plotweaver [-h] [--version]
{version,doctor,run,export,scenario-mars,bakeoff,gui,vxbook,models,sound,brief,provision,mdl-progress,release-shared} ...
VOXPrint AI Plotweaver
positional arguments:
{version,doctor,run,export,scenario-mars,bakeoff,gui,vxbook,models,sound,brief,provision,mdl-progress,release-shared}
version Print the version and codename.
doctor Show the GPU check.
run Write or resume one book.
export Export an existing project, including book.vxbook.
scenario-mars Write the short Russian Mars story and the Audiobook
Builder export.
bakeoff Run the Russian 10x3 bake-off, or a mock slice of it.
gui Open the desktop window.
vxbook Check or inspect a Voxprint Book.
models Registry tools for Model Forge publications.
sound Add VXBOOK v1.1 + sound extension v1 markup.
brief Draft a book brief from loose notes.
provision Copy the bundled runtime and run VOXPrint MDL. A
failed download still exits 0.
mdl-progress Interactive install opens the MDL window. --quiet logs
and stays headless.
release-shared Drop Plotweaver from the shared manifest. Keep files
other apps use.
options:
-h, --help show this help message and exit
--version show program's version number and exit
plotweaver version
usage: plotweaver version [-h]
options:
-h, --help show this help message and exit
plotweaver doctor
usage: plotweaver doctor [-h] [--mock]
options:
-h, --help show this help message and exit
--mock
plotweaver run
usage: plotweaver run [-h] --project PROJECT [--synopsis SYNOPSIS]
[--brief BRIEF] [--title TITLE] [--language {ru,en}]
[--genre GENRE] [--target-words TARGET_WORDS]
[--chapters CHAPTERS]
[--scenes-per-chapter SCENES_PER_CHAPTER]
[--dark-themes | --no-dark-themes]
[--tier {standard,least-censored}]
[--mode {autopilot,copilot,manual}]
[--reference REFERENCE] [--mock] [--yes] [--approve]
[--export-dir EXPORT_DIR] [--main-gguf MAIN_GGUF]
[--least-censored-gguf LEAST_CENSORED_GGUF]
[--main-model-id MAIN_MODEL_ID]
[--least-censored-model-id LEAST_CENSORED_MODEL_ID]
[--author AUTHOR] [--fb2] [--docx] [--markdown]
[--speaker-marks] [--sound] [--json] [--dry-run]
options:
-h, --help show this help message and exit
--project PROJECT
--synopsis SYNOPSIS
--brief BRIEF Book brief in JSON or the Markdown template. Supplies
the book fields.
--title TITLE
--language {ru,en}
--genre GENRE
--target-words TARGET_WORDS
--chapters CHAPTERS
--scenes-per-chapter SCENES_PER_CHAPTER
--dark-themes, --no-dark-themes
--tier {standard,least-censored}
standard, or least-censored (an installed Model Forge
model).
--mode {autopilot,copilot,manual}
--reference REFERENCE
--mock
--yes Do not stop for approval.
--approve Clear the gate the book is waiting on.
--export-dir EXPORT_DIR
--main-gguf MAIN_GGUF
--least-censored-gguf LEAST_CENSORED_GGUF
--main-model-id MAIN_MODEL_ID
--least-censored-model-id LEAST_CENSORED_MODEL_ID
--author AUTHOR Author stored in EPUB and FictionBook title-info.
--fb2 Also write FictionBook 2.1.
--docx Also write DOCX.
--markdown Also write Markdown.
--speaker-marks Also write the legacy numbered speaker-marks pair.
--sound Also write book.sound.vxbook (VXBOOK v1.1 + sound
extension v1).
--json Print one JSON object on stdout. The schema is in
docs/CLI.md.
--dry-run Validate inputs and print the planned actions. Write
nothing and do not run a model.
plotweaver export
usage: plotweaver export [-h] --project PROJECT [--export-dir EXPORT_DIR]
[--mock] [--author AUTHOR] [--fb2] [--docx]
[--markdown] [--speaker-marks] [--sound] [--json]
[--dry-run]
options:
-h, --help show this help message and exit
--project PROJECT
--export-dir EXPORT_DIR
--mock
--author AUTHOR Author stored in EPUB and FictionBook title-info.
--fb2 Also write FictionBook 2.1.
--docx Also write DOCX.
--markdown Also write Markdown.
--speaker-marks Also write the legacy numbered speaker-marks pair.
--sound Also write book.sound.vxbook (VXBOOK v1.1 + sound
extension v1).
--json Print one JSON object on stdout. The schema is in
docs/CLI.md.
--dry-run Validate inputs and print the planned actions. Write
nothing and do not run a model.
plotweaver scenario-mars
usage: plotweaver scenario-mars [-h] [--project PROJECT]
[--export-dir EXPORT_DIR] [--mock] [--yes]
[--main-gguf MAIN_GGUF]
[--least-censored-gguf LEAST_CENSORED_GGUF]
[--main-model-id MAIN_MODEL_ID]
[--least-censored-model-id LEAST_CENSORED_MODEL_ID]
[--author AUTHOR] [--fb2] [--docx]
[--markdown] [--speaker-marks] [--sound]
[--json] [--dry-run]
options:
-h, --help show this help message and exit
--project PROJECT
--export-dir EXPORT_DIR
--mock
--yes Skip bible and outline approval.
--main-gguf MAIN_GGUF
--least-censored-gguf LEAST_CENSORED_GGUF
--main-model-id MAIN_MODEL_ID
--least-censored-model-id LEAST_CENSORED_MODEL_ID
--author AUTHOR Author stored in EPUB and FictionBook title-info.
--fb2 Also write FictionBook 2.1.
--docx Also write DOCX.
--markdown Also write Markdown.
--speaker-marks Also write the legacy numbered speaker-marks pair.
--sound Also write book.sound.vxbook (VXBOOK v1.1 + sound
extension v1).
--json Print one JSON object on stdout. The schema is in
docs/CLI.md.
--dry-run Validate inputs and print the planned actions. Write
nothing and do not run a model.
plotweaver bakeoff
usage: plotweaver bakeoff [-h] [--results RESULTS] [--mock] [--limit LIMIT]
[--allow-other-license]
options:
-h, --help show this help message and exit
--results RESULTS
--mock
--limit LIMIT Only the first N synopses. 0 means all.
--allow-other-license
plotweaver gui
usage: plotweaver gui [-h] [--mock] [--selftest]
options:
-h, --help show this help message and exit
--mock
--selftest Write a one-chapter mock book and exit.
plotweaver vxbook
usage: plotweaver vxbook [-h] {validate} ...
positional arguments:
{validate}
validate Run the Voxprint Book validation checklist.
options:
-h, --help show this help message and exit
plotweaver vxbook validate
usage: plotweaver vxbook validate [-h] [--json] [--dry-run] file
positional arguments:
file
options:
-h, --help show this help message and exit
--json Print one JSON object on stdout. The schema is in docs/CLI.md.
--dry-run Validate inputs and print the planned actions. Write nothing and
do not run a model.
plotweaver models
usage: plotweaver models [-h] {list} ...
positional arguments:
{list}
list List registry models.
options:
-h, --help show this help message and exit
plotweaver models list
usage: plotweaver models list [-h] [--registry REGISTRY] [--json] [--dry-run]
options:
-h, --help show this help message and exit
--registry REGISTRY Registry file to read. Defaults to bakeoff/models.toml.
--json Print one JSON object on stdout. The schema is in
docs/CLI.md.
--dry-run Validate inputs and print the planned actions. Write
nothing and do not run a model.
plotweaver sound
usage: plotweaver sound [-h] {add} ...
positional arguments:
{add}
add Write a new .vxbook with sound markup.
options:
-h, --help show this help message and exit
plotweaver sound add
usage: plotweaver sound add [-h] -o OUTPUT [--mock] [--mirror] [--json]
[--dry-run]
src
positional arguments:
src A .vxbook file or a Plotweaver project folder.
options:
-h, --help show this help message and exit
-o, --output OUTPUT
--mock
--mirror Also write optional vx:sound lines. Off by default.
--json Print one JSON object on stdout. The schema is in
docs/CLI.md.
--dry-run Validate inputs and print the planned actions. Write
nothing and do not run a model.
plotweaver brief
usage: plotweaver brief [-h] {draft} ...
positional arguments:
{draft}
draft Expand notes into a book brief.
options:
-h, --help show this help message and exit
plotweaver brief draft
usage: plotweaver brief draft [-h] --idea IDEA [--language {ru,en}] [--mock]
[--json] [--dry-run]
options:
-h, --help show this help message and exit
--idea IDEA Loose notes to expand.
--language {ru,en}
--mock
--json Print one JSON object on stdout. The schema is in
docs/CLI.md.
--dry-run Validate inputs and print the planned actions. Write
nothing and do not run a model.
plotweaver provision
usage: plotweaver provision [-h]
options:
-h, --help show this help message and exit
plotweaver mdl-progress
usage: plotweaver mdl-progress [-h] [--quiet] [--installer]
options:
-h, --help show this help message and exit
--quiet Write the installer log and do not open a window.
--installer Exit 0 even when the download fails.
plotweaver release-shared
usage: plotweaver release-shared [-h]
options:
-h, --help show this help message and exit