systemg

Search docs

/
Install

Commands

Commands

Quick reference

$ sysg start                     # Launch services
$ sysg stop                      # Stop the current project
$ sysg restart                   # Restart services
$ sysg status                    # Check supervisor health
$ sysg logs -p myapp             # View one project's output
$ sysg inspect -s api            # View metrics
$ sysg validate -c sysg.yaml     # Check a config before running it
$ sysg start --parent-pid 123 --name w1 -- cmd   # Create child
$ sysg purge                     # Clear all state
$ sysg version                   # Binary version vs. the running supervisor

Deprecated

sysg spawn is deprecated. Use sysg start --parent-pid ... for child-process workflows.

Global flags

Every command accepts:

FlagDescription
--log-levelSet verbosity for this invocation (trace, debug, info, warn, error, off, or 5-0)
-v, --verbosePrint live operation progress
--plainAgent-friendly output: disable color, banners, paging, and implicit log following
--sysOpt into privileged system mode (requires root)
--drop-privilegesDrop child privileges during start/restart; accepted but ignored by commands that do not spawn services

--plain is equivalent to setting SYSTEMG_AGENT=1, and is also implied when SYSTEMG_AGENT or NO_COLOR is set in the environment. Use it for scripts, pipes, SSH commands, and coding agents so status, inspect, and logs emit plain, un-truncated, non-blocking output.

$ sysg --plain status              # no color, full unit names
$ SYSTEMG_AGENT=1 sysg logs -s api  # one-shot, stripped, no banners

Supervisor status

sysg status talks to the running supervisor and shows all registered projects. Use filters to narrow the view:

$ sysg start --config app.yaml
$ sysg status                 # Shows all supervisor-known projects
$ sysg status --config app.yaml
$ sysg status --project app

Daemon mode

Run supervisor in background:

$ sysg start --daemonize
$ sysg status                 # Communicates with daemon
$ sysg stop                   # Stops the current project
$ sysg stop --supervisor      # Stops all projects and exits the supervisor

Service-specific operations

Most commands accept a service name:

$ sysg restart --service api
$ sysg logs --service worker
$ sysg stop --service redis

See also

Configurationstart