Skip to content

CandleVM CLI ​

sh
candlevm [OPTIONS] <FILE>

<FILE> is a CandleVM executable to load and run.

OptionDescription
-p, --plugin <PATH>Load a plugin from the given path. Repeat the option to provide multiple plugins.
-d, --debugPrint loading and VM execution diagnostics. This also sets the read-only DEBUG global to true.
-h, --helpPrint command usage and available options.
-V, --versionPrint the CandleVM version.

CandleVM also loads matching plugin files from a plugins directory next to the executable. The accepted file extension depends on the operating system: .dll on Windows, .dylib on macOS, and .so on other Unix systems. Explicitly provided plugin paths are loaded as well; see plugin documentation.

If CandleVM cannot read or load the executable, it prints an error and exits with status 1. On successful loading, the process exits with the VM's exit code.

Built for the Candle ecosystem · Powered by VitePress.