Documentation navigation

Anybuild documentation

CLI Reference

Commands and important options exposed by the anybuild binary.

Commands

Command	Purpose
auto / implicit	Generate when needed, build, optionally run and deploy.
generate	Create or refresh an Anybuild definition.
plan	Evaluate provider config, commands, and services without building.
build	Execute build steps and prepare runtime artifacts.
run	Invoke named commands from an existing build.
deploy	Publish a built Wasmer package or write its deployment config.

Project and configuration options

Option	Meaning
`PATH`	Project path; defaults to the current directory.
`--subdir`	Application directory relative to the project root.
`--anybuild-path`	Use a non-default Anybuild definition.
`--provider`	Force a registered provider.
`--config`	Merge a JSON object over detected provider configuration.
`--install-command`	Override the first install-group step.
`--build-command`	Override the first build-group step.
`--start-command`	Override the start command.
`--serve-port`	Set the plan and runtime port.

Execution options

Option	Meaning
`--docker`	Use the Docker build backend.
`--docker-client`	Select a Docker-compatible client.
`--docker-opts`	Pass extra client options.
`--wasmer`	Use the Wasmer runtime and package layout.
`--wasmer-bin`	Select the Wasmer binary.
`--wasmer-registry`	Select the Wasmer registry.
`--wasmer-token`	Authenticate Wasmer build/deploy operations.
`--skip-prepare`	Do not execute plan prepare steps.
`--env-name`	Load .env.<name> files during build.

Run and deploy options

Option	Meaning
`-c, --command`	Run a named command; repeatable.
`--start`	Run the start command.
`--after-deploy`	Run the after_deploy command.
`--volume NAME:/path`	Attach or override a named volume mapping.
`--wasmer-deploy`	Build for Wasmer and publish.
`--wasmer-deploy-config PATH`	Write deployment metadata instead of publishing.
`--wasmer-app-owner`	Set the Wasmer owner.
`--wasmer-app-name`	Set the Wasmer application name.

Generation options

Option	Meaning
`--regenerate`	Rewrite the detected Anybuild definition before auto/plan.
`--temp-anybuild`	Use an operation-scoped temporary definition.
`--out, -o`	Write generated definition or plan output to a path.