Command line

Open the interface

Running pqsetup without a subcommand starts the local interface.

pqsetup
pqsetup serve --host 127.0.0.1 --port 8888
pqsetup serve --no-browser

The server only accepts 127.0.0.1 or localhost. The startup screen shows the browser address and detected PQ environment. The browser opens after the server is ready. Stop with Ctrl+C.

Server logs

Structure loading, perturbation, exports, errors and shutdown appear in the terminal. Routine polling and static requests are quiet at info.

pqsetup serve --log-level debug --no-browser
pqsetup serve --no-browser 2> pqsetup.log

Logs go to standard error; the startup address goes to standard output. Redirected output is plain text. NO_COLOR=1 disables terminal colors.

Level	Events
debug	Actions, requests and server details
info (default)	Actions, readiness and shutdown
warning	Rejected requests and errors
error	Failed requests and server errors

Inspect the environment

pqsetup doctor
pqsetup doctor --json

doctor exits with 0 when PQ is found and 1 when it is not found.

Validate an input

pqsetup validate run.in
pqsetup validate --json run.in

Exit status:

Status	Meaning
0	Available checks passed
1	Local or PQ validation reported an invalid input
2	PQ validation could not run because of an explicit configuration or probe error

Select a PQ executable

The global option works before the subcommand:

pqsetup --pq-executable /opt/pq/bin/PQ doctor
pqsetup --pq-executable /opt/pq/bin/PQ validate run.in
pqsetup --pq-executable /opt/pq/bin/PQ serve

PQSetup resolves the executable in this order:

1. --pq-executable

2. the saved PQSetup configuration

3. PQ_EXECUTABLE

4. PQ or pq on PATH

5. a nearby PQ development build, when present

The saved configuration lives at $XDG_CONFIG_HOME/pqsetup/config.json, or ~/.config/pqsetup/config.json when XDG_CONFIG_HOME is unset.

Version

pqsetup --version