validate

Check a configuration file before you run it. validate parses the manifest, resolves the dependency graph, and — when something is wrong — tells you the exact line, why it’s an error, and how to fix it.

$ sysg validate -c sysg.yaml

  ✗ invalid  sysg.yaml · 1 problem

  1. missing-version  line 1:1
     missing field `version`

     1 │ services:
         ^

     why  Every manifest must declare its schema version at the top level.
     fix  Add `version: "2"` as the first key in the file.
     docs https://sysg.dev/how-it-works/configuration

A clean file reports success and exits 0:

  ✓ valid  sysg.yaml
  This manifest parses and resolves cleanly.

Options

Short	Long	Description
`-c`	`--config`	Path to the configuration file (defaults to `systemg.yaml`)
`-`	`--format`	Emit machine-readable output (`json` or `xml`)
`-v`	`--verbose`	Print operation progress
`-`	`--no-color`	Disable ANSI colors
`-`	`--sys`	Opt into privileged system mode. Requires root
`-`	`--drop-privileges`	Accepted globally but ignored; validate does not spawn services
`-`	`--plain`	Agent-friendly output (also disables color)
`-`	`--log-level`	Set logging verbosity for this invocation (`trace` through `off`, or 5-0)

What it checks

Schema — version 2, services in each declared project or loose bundle, and a command per service.
Syntax — YAML that parses, with a caret pointing at the offending token.
Health checks — every deployment.health_check has a url or a command.
Dependencies — depends_on references exist and form no cycle.
Project id — every named project has a valid, non-empty id.
Environment — ${VAR} interpolations resolve from the environment or env file.

Exit codes

Code	Meaning
`0`	Configuration is valid
`1`	Configuration has one or more problems

JSON output

Use --format json for CI gates and tooling. Each diagnostic carries its location, category, message, and remediation:

$ sysg validate -c sysg.yaml --format json

{
  "config": "sysg.yaml",
  "valid": false,
  "diagnostics": [
    {
      "line": 1,
      "column": 1,
      "kind": "missing-version",
      "message": "missing field `version`",
      "why": "Every manifest must declare its schema version at the top level.",
      "suggestion": "Add `version: \"2\"` as the first key in the file.",
      "doc": "https://sysg.dev/how-it-works/configuration"
    }
  ]
}

Example

Gate a deploy on a valid manifest:

$ sysg validate -c production.yaml --plain || exit 1
$ sysg start -c production.yaml --daemonize

Installation

How It Works

Examples

Integrations

validate

validate

Options

What it checks

Exit codes

JSON output

Example

See also

​validate

​Options

​What it checks

​Exit codes

​JSON output

​Example

​See also

validate

Options

What it checks

Exit codes

JSON output

Example

See also