Skip to content
ghqc

UI

ghqc ui starts the ghqc API and serves the embedded React frontend from the same port. It is the quickest way to run the full local app without a separate frontend dev server.

Terminal window
ghqc ui

ghqc ui does not have an interactive prompt mode. It starts the server, optionally opens your browser, and keeps running until you stop it.

Terminal window
ghqc ui
Terminal window
ghqc ui --port 8080 --no-open
Terminal window
ghqc ui url

If --port is omitted, ghqc ui binds a random available port.

After startup, it opens the exact loopback URL selected on the current machine:

  • http://127.0.0.1:<port> when using IPv4
  • http://[::1]:<port> when using IPv6

This avoids mismatches between the listener address and the browser URL.

Use --no-open when you want to:

  • keep startup fully terminal-only
  • launch the browser yourself
  • run the UI in remote shells, CI, or headless environments

ghqc ui url prints the exact URL the embedded UI would use and exits without starting the app.

Terminal window
ghqc ui url
Terminal window
ghqc ui url --port 8080

This is useful when another tool needs to know the UI address ahead of time.

Like ghqc ui, omitting --port lets the OS choose an available port.

The embedded UI uses route-based navigation. Each main screen has its own URL path, so you can reload or open the app directly to a specific screen.

RouteScreen
/statusQC status board
/createCreate workflow
/recordRecord generation
/archiveArchive generation
/configurationConfiguration tab

Opening / redirects to /status.

FlagDescription
[url]Print the exact UI URL and exit instead of starting the server.
-p, --portPort to listen on. Omit it to bind a random available port.
--no-openStart the server without opening a browser tab.
--ipv4-onlyForce an IPv4-only listener and 127.0.0.1 loopback URL.
-d, --directorySet the git project directory the UI should operate on.
--config-dirOverride the configuration directory used by the UI.

ghqc ui is available when the binary is built with the ui feature. That feature also pulls in the API server automatically.

Terminal window
cargo build --features cli,ui --release
./target/release/ghqc ui