Tailed
  • Tailed
  • How it works
  • Zero-Install Web Tailer
    • Getting Started
    • Limitations
  • Command Line Tool
    • Installation
    • Reference
  • Client Libraries
    • .NET
    • Node JS
  • Colorization
    • Standard Rules
    • Custom Rules
  • Roadmap
  • GitHub Repositories
Powered by GitBook
On this page
  • Displaying the "help" content
  • Switches
  1. Command Line Tool

Reference

Understanding the available command line switches.

Displaying the "help" content

The standard "help" text can be displayed using the following command:

tailed --help

The output is as follows:

Tailed 1.0.0
Copyright (C) 2023 Chris Wood

USAGE:
Monitor a log file:
  tailed /path/to/my/file.log
Monitor a log file and use Serilog colorization rules:
  tailed --rules Serilog /path/to/my/file.log
Monitor a log file and use custom colorization rules:
  tailed --rulesFile /path/to/rules.json /path/to/my/file.log
Monitor a log file with a custom web server:
  tailed --hostname my.domain.com /path/to/my/file.log

  -c, --rulesFile      Optional path to a file containing JSON colorization
                       rules.
  -r, --rules          (Default: None) A default colorization rule set. Valid
                       values: None, Serilog
  -h, --hostname       Optional override of the Tailed server hostname.
  --help               Display this help screen.
  --version            Display version information.
  Filename (pos. 0)    Required. The path to the file which will be tailed.

See the documentation at https://docs.tailed.live

Switches

The main switches are:

Switch
Description

-c or --rulesFile

-c or --rules

Allows you to specify a standard set of colorization rules. Available choices include: None, Serilog.

-h or --hostname

Allows you to use a domain name other than tailed.live if you host your own server.

The command will continue to run until it is killed (e.g. Ctrl + C). You may also consider backgrounding the command (e.g. using & in Linux).

PreviousInstallationNext.NET

Last updated 1 year ago

The path to a JSON file containing colorization rules, as explained on the page.

Colorization