Skip to main content

CLI Options

The livedoc-viewer CLI has two modes: server mode (default) for real-time test visualization, and the export subcommand for generating self-contained static HTML reports.

# Server mode
livedoc-viewer [options]

# Export mode
livedoc-viewer export --input <path> [--output <path>] [--title <title>]

Server Options​

--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

export Subcommand​

Generate a self-contained static HTML report from a TestRunV1 JSON file. The output file embeds all JavaScript, CSS, and images inline — it can be opened in any browser on any computer with zero external dependencies.

livedoc-viewer export --input <path> [--output <path>] [--title <title>]

--input <path> / -i​

(Required) Path to a TestRunV1 JSON file. This is the file produced by the export option on LiveDocSpecReporter or by the LIVEDOC_EXPORT_PATH environment variable in the .NET reporter.

livedoc-viewer export --input ./test-results/livedoc-report.json
livedoc-viewer export -i ./test-results/livedoc-report.json

The file must contain valid JSON with protocolVersion: "1.0". If the file is missing or the format is invalid, the command exits with a descriptive error.

--output <path> / -o​

Output path for the generated HTML file. Directories are created automatically.

--output <path>
-o <path>

Default: ./livedoc-report.html

livedoc-viewer export -i results.json -o ./reports/build-42.html

--title <title> / -t​

Custom title for the HTML report. Appears in the browser tab and page header.

--title <title>
-t <title>

Default: The project field from the JSON file, or "LiveDoc" if not set.

livedoc-viewer export -i results.json -t "Sprint 42 — Regression Suite"

Export Output​

On success, the command prints:

✅ LiveDoc report exported successfully!
   Input:  ./test-results/livedoc-report.json
   Output: /absolute/path/to/livedoc-report.html
   Size:   847.3 KB

   Open in any browser to view your test results.

The generated HTML file contains:

  • The full LiveDoc Viewer React application (JS + CSS inlined)
  • All test data from the input JSON (embedded in a <script> tag)
  • Base64-encoded screenshots and attachments (if present in the test data)
  • Dark theme by default
File size expectations
  • Without screenshots: typically 700 KB–1 MB (mostly the bundled viewer JS/CSS)
  • With screenshots: 5 MB+ depending on the number and resolution of images

Export Quick Reference​

OptionShortRequiredDefaultDescription
--input <path>-iYes—Path to TestRunV1 JSON file
--output <path>-oNo./livedoc-report.htmlOutput HTML file path
--title <title>-tNoProject name or "LiveDoc"Custom report title

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.

Server Quick Reference​

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​