Skip to main content

CLI Options

The livedoc-viewer command accepts several flags to control the server's port, host binding, and browser behavior. This page documents every available option.

livedoc-viewer [options]

Reference​

--port <port> / -p​

Port number the viewer server listens on.

--port <port>
-p <port>

Default: 3100

livedoc-viewer --port 8080
livedoc-viewer -p 8080

If the specified port is already in use, the viewer exits with an error message suggesting an alternative.

--host <host> / -H​

Network interface to bind the server to.

--host <host>
-H <host>

Default: localhost

# Bind to all interfaces (allows remote access)
livedoc-viewer --host 0.0.0.0

# Bind to a specific IP
livedoc-viewer -H 192.168.1.50
Security

Binding to 0.0.0.0 exposes the viewer to your entire network. Only do this on trusted networks or in CI environments behind a firewall.

--no-open​

Prevent the viewer from automatically opening a browser window on startup.

--no-open

Default: browser opens automatically

livedoc-viewer --no-open

This is essential for CI/CD environments and headless servers where no browser is available. See the CI/CD Dashboards guide for more.

--version / -V​

Print the installed version number and exit.

--version
-V
livedoc-viewer --version
# 1.2.3

--help / -h​

Display the help text with all available options and exit.

--help
-h
livedoc-viewer --help

Usage Examples​

Default startup​

livedoc-viewer

Starts the viewer on localhost:3100 and opens the browser.

Custom port, no browser​

livedoc-viewer --port 3200 --no-open

Useful for scripted environments where the port is pre-determined.

Network-accessible for CI​

livedoc-viewer -p 3100 --host 0.0.0.0 --no-open

Binds to all interfaces so other machines on the network (or CI jobs) can send results to this viewer instance.

Full combination​

livedoc-viewer --port 9000 --host 0.0.0.0 --no-open

Runs the viewer on port 9000 bound to all interfaces with no browser auto-open — a typical CI/CD configuration.

Quick Reference Table​

OptionShortDefaultDescription
--port <port>-p3100Port to run the server on
--host <host>-HlocalhostHost interface to bind to
--no-open—(opens)Don't open browser automatically
--version-V—Show version number and exit
--help-h—Display help text and exit

See Also​