Documentation

Vectron examples

Concrete `vectron.toml` configuration patterns you can adapt to real local workspaces.

Vectron examples sit between the guides and the field reference. Use them when you understand the basics and want to see what a realistic vectron.toml can look like.

These examples are derived from real frontend and backend workspaces, then reduced to focused, copyable patterns. They are not dumps of internal project configuration.

This section is dedicated to process orchestration examples for vectron.toml. For vectron.stack.toml examples, see the stack examples.

Pick a starting point

Example	Use it when
Frontend workspace	You run a few web-facing development processes together
Shared log readiness	Many services print the same ready signal
Log template presets	You want structured JSON/logfmt logs to be readable in the TUI
Before hooks and env files	Local services need setup before they start
Large service workspace	A monorepo has many services that follow the same launch convention

How to use examples

Start from the closest shape, then replace names, commands, readiness patterns, and paths with your own project conventions.

For exact field behavior and defaults, use the vectron.toml reference.

If you are working on vectron stack instead of vectron.toml, continue with the stack examples.

Pages in this section

Frontend workspace - Run a small frontend workspace with multiple dev servers and log-based readiness.
Shared log readiness - Avoid repeating the same readiness probe on every process.
Log template presets - Render structured process logs with reusable presets and local overrides.
Before hooks and env files - Prepare a local environment before Vectron starts your long-running processes.
Large service workspace - Keep a large service list readable with shared conventions and global defaults.