Skip to main content

Command Line Interface

Inkweaver Studio includes a command line interface (CLI) that lets you build and deploy your novels from the terminal. This makes it straightforward to integrate Inkweaver into CI/CD workflows, deployment scripts, or any other tooling your team uses.

The CLI is included with your Inkweaver Studio installation and requires no separate setup.

Build Output​

When you build a project, Inkweaver flattens all of your resources (screenplay files, images, and any other assets) into a single output folder. Each file is renamed to a hash of its contents.

A manifest.json file is included in the build output. It maps every file in your workspace to its hashed counterpart in the build, and serves as the index for the entire package.

Manifest Structure​

Each entry in the manifest is keyed by the file's logical URL, which is its path in the workspace with any locale in the path replaced with <locale>. For example, /screenplay/<locale>/chapter1.txt. This logical URL is used to reference all localizations of that file.

Each logical URL entry contains:

  • dependencies — Other files generated by the build for this file. For example, a PSD file may produce several image layers as part of the build. These are listed here.
  • locales — A map of localized versions of the file, keyed by locale. Each entry contains:
    • physicalUrl — The path to the file in the build output.