Quickstart

1. Initialize the config

vectron init

This writes a minimal vectron.toml that you can edit for your first run. If you want the complete documented example instead, run vectron init --example.

2. Validate the configuration

vectron check

Use check to catch invalid paths, empty commands, malformed log templates, invalid readiness configuration, and other config-level errors before starting processes.

3. Preview the startup plan

vectron start --dry-run

This prints the resolved startup plan without launching anything.

4. Start the workspace

vectron start

When stdout is attached to a supported terminal, Vectron starts the TUI. Otherwise it falls back to plain terminal output.

5. Inspect the running workspace

vectron status
vectron logs --target web

The status and logs commands talk to the running workspace through the local control endpoint recorded in .vectron/runtime.json.

6. Iterate on the config

Common next steps:

• add more [[process]] entries
• set port_env and port allocation defaults
• define a group and optional startup labels
• add readiness probes
• configure log templates for JSON or logfmt output

For the smallest useful config, continue with First vectron.toml.