GroupDocs.Viewer-CLI

GroupDocs.Viewer CLI

View documents in the browser from your terminal. Powered by GroupDocs.Viewer for .NET — supports 180+ file formats including PDF, Word, Excel, PowerPoint, images, CAD drawings, archives, ebooks, and source code.

groupdocs-viewer .

   ____                    ____
  / ___|_ __ ___  _   _ _ |  _ \  ___   ___ ___
 | |  _| '__/ _ \| | | | '| | | |/ _ \ / __/ __|
 | |_| | | | (_) | |_| | ,| |_| | (_) | (__\__ \
  \____|_|  \___/ \__,_|_|| ____/ \___/ \___|___/
                          |_|
  V I E W E R  26.3.0

  Serving files from: /home/user/documents
  Listening on: http://localhost:8080/

  Press Ctrl+C to stop the server.

Install

Requires .NET 8 or later.

dotnet tool install --global GroupDocs.Viewer-CLI

Quick Start

View all files in the current directory:

groupdocs-viewer

View files in a specific directory:

groupdocs-viewer ~/documents

Open a single file directly (file browser disabled):

groupdocs-viewer report.pdf

The browser opens automatically at http://localhost:8080/.

Options

Usage: groupdocs-viewer [path] [options]

Arguments:
  path                       File or directory to serve (default: current directory)

Options:
  -p, --port <port>          Port to listen on (default: 8080)
  -b, --bind <address>       Bind address (default: localhost)
      --no-open              Don't auto-open browser
  -l, --license-path <path>  Path to GroupDocs license file
  -t, --viewer-type <type>   Viewer type: Html, HtmlExt, Png, Jpg (default: Html)
  -v, --verbose              Enable verbose logging
      --version              Show version info
  -h, --help                 Show help

Examples

Serve on a custom port:

groupdocs-viewer --port 3000

Use image-based rendering:

groupdocs-viewer --viewer-type Png

Bind to all interfaces (e.g. for Docker or LAN access):

groupdocs-viewer --bind 0.0.0.0

Licensing

Without a license the viewer runs in evaluation mode — only the first 2 pages of each document are rendered.

You can request a free 30-day temporary license at purchase.groupdocs.com/temporary-license.

The license is resolved in the following order:

1. --license-path option
2. GROUPDOCS_LIC_PATH environment variable
3. GroupDocs.Viewer.lic in the current directory
4. GroupDocs.Viewer.Product.Family.lic in the current directory

# Option
groupdocs-viewer --license-path /path/to/GroupDocs.Viewer.lic

# Environment variable
export GROUPDOCS_LIC_PATH=/path/to/GroupDocs.Viewer.lic
groupdocs-viewer

Docker

docker build -t groupdocs-viewer -f src/GroupDocs.Viewer.Cli/Dockerfile .
docker run -p 8080:8080 -v /path/to/files:/files groupdocs-viewer /files

Linux Dependencies

On Linux, install the following packages:

sudo apt-get update
sudo apt-get install -y libc6-dev libgdiplus libx11-dev libfontconfig1 ttf-mscorefonts-installer

Supported Formats

See the full list at docs.groupdocs.com/viewer/net/supported-document-formats.

Resources

• GroupDocs.Viewer for .NET — product page
• Documentation — developer guide
• Free Support — community forum
• Temporary License — free 30-day trial