Inkweaver CLI
The Inkweaver command line interface (CLI) builds, previews, and packages your novels and plugins. You run it with the ink command:
ink <command> [options]Commands
Section titled “Commands”init creates a new novel workspace, named after its folder.
ink init [options]It creates the workspace in the --target folder, which defaults to the current folder.
Example
ink initinit-plugin
Section titled “init-plugin”init-plugin creates a new plugin project.
ink init-plugin [options]It creates the plugin in the --target folder, which defaults to the current folder.
Example
ink init-pluginbuild builds your novel from its workspace.
ink build [options]It reads from the --workspace folder, which defaults to the current folder, and writes to the --target folder, which defaults to the default build folder. Add --clean to remove old output first.
Example
ink build --cleanpreview
Section titled “preview”preview builds your novel and opens it for preview. While it’s running, it rebuilds whenever a file in your workspace changes, and reloads the preview.
ink preview [options]It uses the same --workspace and --target defaults as build.
Example
ink previewbottle
Section titled “bottle”bottle packages a plugin as an .inkb file, including every file in the plugin’s folder.
ink bottle [options]It packages the --workspace folder, which defaults to the current folder, and writes the file to the --target folder, which also defaults to the current folder.
Example
ink bottle --workspace ./my-plugin --target ./my-plugin/releaseversion
Section titled “version”version prints the CLI’s version.
ink versionhelp prints a list of commands and options. Running ink with no command does the same thing.
ink helpOptions
Section titled “Options”Each option has a short form and a long form. They work the same way.
-c, --clean
Section titled “-c, --clean”--clean removes old output before building. It doesn’t take a value.
ink build --cleanink build -c-t, --target
Section titled “-t, --target”--target sets the folder a command writes to. For build and preview, it defaults to the default build folder. For init, init-plugin, and bottle, it defaults to the current folder.
ink build --target ./distink build -t ./dist-w, --workspace
Section titled “-w, --workspace”--workspace sets the folder a command works on. It defaults to the current folder.
ink build --workspace ./my-novelink build -w ./my-novel