Skip to content

Configuration Reference

david edited this page Dec 27, 2025 · 1 revision

Configuration Reference

The heart of Turbostar is the manifest.json file. This file tells the engine which processes to spawn and how they relate to each other.

Schema

{
  "services": [
    {
      "name": "SERVICE_NAME",
      "command": "shell_command_here",
      "color": "ANSI_COLOR_CODE",
      "ready_signal": "optional_string_to_wait_for",
      "depends_on": "optional_service_name"
    }
  ]
}

Field Definitions

Field Type Required Description
name String Yes Unique identifier for the service. Used in logs.
command String Yes The actual command to run (e.g., python main.py, npm start).
color String No ANSI escape code for log prefix.
ready_signal String No A substring to look for in stdout. When found, marks service as READY.
depends_on String No The name of another service. This service will NOT start until the dependency is READY.

Advanced Example

{
  "services": [
    {
      "name": "DB",
      "command": "docker-compose up db",
      "ready_signal": "database system is ready to accept connections",
      "color": "\u001b[34m"
    },
    {
      "name": "API",
      "command": "python app.py",
      "depends_on": "DB",
      "ready_signal": "Application startup complete",
      "color": "\u001b[32m"
    },
    {
      "name": "WEB",
      "command": "npm run dev",
      "depends_on": "API",
      "color": "\u001b[33m"
    }
  ]
}

Clone this wiki locally