Skip to content

Command line

The vigie binary runs the server and checks its configuration. Run vigie --help, or vigie <command> --help, for the same text in your terminal.

Usage: vigie <command>
Commands:
serve --config-path="./config.yml"
Run the endpoint discovery server.
check-config --config-path="./config.yml"
Check a configuration file, unknown keys included, without running the
server.
version
Show version.

Every command accepts -h/--help. A command that fails prints vigie: error: <message> and exits with code 1.

Runs the server with the configuration file, until the process is stopped.

FlagDefaultDescription
-c, --config-path./config.ymlPath of the configuration file.

serve ignores the keys of the file it doesn’t know, so check the file with check-config first. It fails at start when the file is invalid or one of its sourcesWhere a service reads its endpoints, one of dns, file, url or kubernetes. See Services and sources. can’t be built, such as a kubeconfig that can’t be loaded. It also fails when it can’t listen on server.listen_addr.

Once started, the process reloadsReading the configuration file again to replace the services, on SIGHUP or POST /reload. See Reload the services. its services on SIGHUP, see Reload the services. It logs to the standard error, in text or in JSON as log sets.

Checks a configuration file without running the server, and prints config <path> is valid with the absolute path of the file.

FlagDefaultDescription
-c, --config-path./config.ymlPath of the configuration file.

It runs the same checks as serve, and also refuses the keys it doesn’t know, which serve ignores. It doesn’t build the sources, so it doesn’t load the kubeconfig of a kubernetes source or read any source.

Terminal window
$ vigie check-config -c /etc/vigie/config.yml
vigie: error: invalid config /etc/vigie/config.yml: yaml: unmarshal errors:
line 2: field listen_adr not found in type config.plain

Prints the version of the binary with the commit and the date it was built from.

Terminal window
$ vigie version
vigie 0.1.0, commit 3596a75, built at 2026-10-30T10:00:00Z

A binary built with go build without the release flags prints vigie 0.0.1-dev, commit none, built at unknown.