Skip to content

This is the multi-page printable view of this section. .

Return to the regular view of this page.

Reference

Look up configuration and commands without reading a tutorial.

Use this section when you already know what you need to find.

1 - Configuration

Record supported keys, defaults, and examples in one place.

Replace this small table with the public configuration surface of your project.

KeyTypeDefaultMeaning
listenstring127.0.0.1:8080Address used by the local server
log_levelstringinfoMinimum emitted log level
read_onlybooleanfalseDisable operations that change state

Example

listen: 0.0.0.0:8080
log_level: debug
read_only: true

Document validation and precedence beside the keys, not in a separate hidden guide.

2 - Command Reference

List each command with its purpose, syntax, and exit behavior.

project start

Starts the local service.

project start [--config FILE] [--listen ADDRESS]

project check

Validates configuration without starting the service. Exit status 0 means valid; any non-zero status means the configuration must not be deployed.

project check [--config FILE]

Replace these placeholders with commands copied from your real CLI help output.