Command Reference¶
This page lists every command in quinectl 1.0.10. quinectl <command> --help prints the
same flags, and most commands add examples.
Flags for every command¶
| Flag | Default | Description |
|---|---|---|
--color <string> |
auto |
When to color output: auto, always or never. With auto, color is on only in a terminal, and the color environment variables apply; see Environment Variables. |
--no-color |
Turn off colored output, like --color=never. |
|
-f, --spec <string> |
./quinectl.yaml |
The quinectl.yaml to read. Relative paths in the file resolve against the file's own directory. |
--timeout <duration> |
5m0s |
How long to wait for each service to become ready before giving up. Must be greater than zero. Loading Kafka seed files does not count against it. |
-v, --verbose |
Print more detail while commands run (up, down, and so on). Repeat for more (-vv). The detail goes to standard error, so standard output and --json output don't change. |
|
--version |
Print the version and exit, like quinectl version. Use it on quinectl alone, not after a command. |
Commands¶
quinectl agent¶
Print a self-contained guide to driving quinectl from scripts and AI agents. See Using quinectl from AI Agents.
| Flag | Default | Description |
|---|---|---|
--json |
Print a machine-readable list of commands, flags, exit codes, environment variables and prerequisites instead. | |
--schema |
Print the quinectl.yaml schema as JSON instead. |
quinectl cass-reset¶
Delete this directory's graph data on the local Cassandra: every keyspace its products use. Other directories' keyspaces on the same Cassandra are not touched, and while another directory declares the same keyspace, it refuses and deletes nothing. Asks first.
| Flag | Default | Description |
|---|---|---|
-y, --yes |
Skip the confirmation prompt. |
quinectl completion¶
Print a shell completion script. See Shell Completion.
quinectl completion bash¶
Print the completion script for bash.
| Flag | Default | Description |
|---|---|---|
--no-descriptions |
Complete names only, without a short description beside each. |
quinectl completion fish¶
Print the completion script for fish.
| Flag | Default | Description |
|---|---|---|
--no-descriptions |
Complete names only, without a short description beside each. |
quinectl completion powershell¶
Print the completion script for PowerShell.
| Flag | Default | Description |
|---|---|---|
--no-descriptions |
Complete names only, without a short description beside each. |
quinectl completion zsh¶
Print the completion script for zsh.
| Flag | Default | Description |
|---|---|---|
--no-descriptions |
Complete names only, without a short description beside each. |
quinectl down¶
Stop the Quine and Novelty members this directory started, and remove their containers. The graph
is kept. Services such as Cassandra and Keycloak keep running so the next up is fast, and their
containers are not removed. Add --all to stop members and quinectl's service containers for
every directory on the machine, and --rm or --purge to remove containers. See Multi-tenancy.
| Flag | Default | Description |
|---|---|---|
--all |
Act on the whole machine instead of this directory. Stops every directory's members and every quinectl service container. | |
--dry-run |
Show what would be stopped or removed, and change nothing. | |
--json |
Print the --dry-run preview as JSON. Requires --dry-run. |
|
--orphans |
Also stop Quine processes quinectl finds running that it didn't start. Without this flag they are only reported. | |
--purge |
Remove the containers and their data. Without --all, refused the same way as --rm. |
|
--rm |
Remove the containers. This deletes the graph stored in Cassandra; Kafka topics and Keycloak users are kept. Without --all, run plain quinectl down first: while this directory's members may still be running, it refuses with exit 1 and changes nothing. It also refuses, with exit 1, while another directory still uses a shared service. |
|
-y, --yes |
Confirm removal without a prompt, for scripts. Requires --all together with --rm or --purge. |
quinectl gc¶
Clean up what deleted project directories left behind on this machine: quinectl's own bookkeeping,
Grafana dashboards, plus keyspaces, Keycloak realms, Kafka topics and per-directory containers
that no remaining configuration uses. Asks before deleting anything. Preview first with --dry-run.
| Flag | Default | Description |
|---|---|---|
--dry-run |
Show what would be cleaned up, and change nothing. | |
--json |
Print the --dry-run plan as JSON. Requires --dry-run. |
|
-y, --yes |
Skip the confirmation prompt. |
quinectl generate-config¶
The same file init writes, printed to stdout or written to the path you give with -o. Use it to
start a configuration somewhere other than ./quinectl.yaml, or to compare your file with
the current defaults.
| Flag | Default | Description |
|---|---|---|
--agent |
Same as init --agent. |
|
--edition <string> |
enterprise or oss. Without it, the edition of a Quine jar in the current directory, otherwise Enterprise. With jars of both editions, it asks. |
|
--force |
Replace an existing file at the --output path. |
|
--minimal |
Leave out the explanatory comments. | |
-o, --output <string> |
Write to this path instead of stdout. | |
--with-novelty |
Same as init --with-novelty. |
quinectl generate-quine-conf¶
Start the services and write each product's configuration file, without launching the product. Use it to see exactly what Quine Enterprise or Novelty will be given, or to pull images ahead of time.
| Flag | Default | Description |
|---|---|---|
--dry-run |
Write the configuration from the quinectl.yaml alone, without starting any service. The product image must already be on the machine. |
|
--json |
Print a summary of the files written as JSON. Requires --dry-run. |
|
--pull |
Pull the product image again on this run even if it is already on the machine. |
quinectl init¶
Write a complete, commented quinectl.yaml into the current directory and print what to do
next. It runs unedited. Without --edition, it writes a Quine Enterprise file, unless a Quine jar in
the directory says otherwise. Refuses to replace an existing file unless you pass --force.
Never touches Docker.
| Flag | Default | Description |
|---|---|---|
--agent |
Pick the web and cluster ports, keyspace and Keycloak realm from this directory's path instead of the usual defaults, and suggest a proxy port and Kafka namespace in comments, so the file doesn't collide with another deployment on the same machine. See Let quinectl pick the values. | |
--edition <string> |
enterprise or oss. Without it, the edition of a Quine jar in the current directory, otherwise Enterprise. With jars of both editions, it asks. |
|
--force |
Replace an existing ./quinectl.yaml. |
|
--minimal |
Write the same settings without the explanatory comments. | |
--with-novelty |
Add a novelty: block so one up runs Novelty beside Quine Enterprise. |
quinectl kafka-reset¶
Delete this directory's own topics on the local Kafka broker, so the next up creates them again
and reloads their seed files. Other directories' topics are not touched, except a topic two
directories share because neither uses a namespace or both use the same one: it is deleted for both. Asks first.
| Flag | Default | Description |
|---|---|---|
-y, --yes |
Skip the confirmation prompt. |
quinectl status¶
Report the services quinectl manages, every member it started (from any directory on this machine), the sample users when Keycloak auth is on, and declared Kafka topics with their record counts. Read-only.
| Flag | Default | Description |
|---|---|---|
--json |
Print the report as JSON. |
quinectl token¶
Print a bearer token for one of the sample users, for calling the REST API of a product behind
Keycloak auth: -H "Authorization: Bearer $(quinectl token)". Needs services.auth: keycloak
and a previous up. Tokens expire after five minutes; run it again for a fresh one.
| Flag | Default | Description |
|---|---|---|
--json |
Print JSON with the token, its type, seconds until it expires, the user, and the token endpoint. | |
--product <string> |
Which product's login to use, quine or novelty. Defaults to quine when the file declares it, wherever it appears in the file. |
|
--user <string> |
Which sample user to sign in as. Defaults to the first user, superadmin1 unless you changed the user list. |
quinectl trust¶
macOS only. Add quinectl's local certificate authority to your login keychain, so your browser
accepts the Keycloak sign-in page without a warning. Run it once per machine. --remove takes it
out again.
| Flag | Default | Description |
|---|---|---|
--json |
Print the --status report as JSON. Requires --status. |
|
--remove |
Remove the certificate authority from the keychain instead of adding it. | |
--status |
Report whether the certificate authority is trusted, and change nothing. | |
-y, --yes |
Skip the confirmation prompt. |
quinectl up¶
Start every service the configuration asks for, write each product's configuration file to match,
and launch Quine Enterprise, Novelty, or both. Anything already running and matching is reused
as-is. Every member runs in the background: up returns once they are ready, and pressing
Ctrl-C during up never stops a member it already launched. Once a member is ready, up prints
copy-pasteable curl commands to check it.
| Flag | Default | Description |
|---|---|---|
--no-launch |
Start the services and write the configuration, but don't launch Quine or Novelty. | |
--pull |
Pull the product image again on this run even if it is already on the machine. |
quinectl version¶
Print the quinectl version, its build details, and the Quine release line it was tested with.
| Flag | Default | Description |
|---|---|---|
--json |
Print the same as JSON. |
Exit codes¶
quinectl exits 0 on success, 1 when something failed, and 2 when nothing was changed because the
command or the configuration needs fixing. Exit codes in Scripting
and CI lists what each one covers. That page also describes output streams and JSON output.