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”Creates a new novel workspace, named after its folder.
ink init [options]The workspace is created in the --target folder, which defaults to the current folder.
Example
ink initinit-plugin
Section titled “init-plugin”Creates a new plugin project.
ink init-plugin [options]The plugin is created in the --target folder, which defaults to the current folder.
Example
ink init-pluginBuilds a novel workspace.
ink build [options]Reads from the --workspace folder, which defaults to the current folder, and writes to the --target folder, which defaults to the default build folder. Use --clean to remove old output first.
Example
ink build --cleanpreview
Section titled “preview”Builds your novel and opens it for preview. While it’s running, it rebuilds whenever a file in your workspace changes.
ink preview [options]Uses the same --workspace and --target defaults as build.
Example
ink previewbottle
Section titled “bottle”Packages a plugin as an .inkb file, including every file in the plugin’s folder.
ink bottle [options]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”Prints the version of the CLI.
ink versionPrints 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”Removes old output before building. Takes no value.
ink build --cleanink build -c-t, --target
Section titled “-t, --target”Sets the folder a command writes to. build and preview default to the default build folder, and init, init-plugin, and bottle default to the current folder.
ink build --target ./distink build -t ./dist-w, --workspace
Section titled “-w, --workspace”Sets the folder a command works on. Defaults to the current folder.
ink build --workspace ./my-novelink build -w ./my-novel