Skip to main content

Usage

Commands​

The links tool provides several commands:

  • inspect: check the status of links on a given host,
  • config: view and modify configuration settings,
  • version: display the current version of the tool,
  • help: display help information for the tool and its commands.

Global Flags​

The links tool supports several global optional flags that can be used with any command:

  • --config: specify a path to a configuration file,
  • -h or --help: display help information for the tool or a command.

Inspect Command​

The inspect command is the main command of the links tool. It allows you to check the status of links on a given host. Example:

links inspect --host=example.com

This command will start inspecting links on the specified host, starting from the root page (/).

The inspect command supports several flags:

  • --host: specify the host to inspect (required),
  • --path: specify the starting page for inspection (optional),
  • --skipOK: do not output results for links returning 200 status codes (optional),
  • -o or --out: specify the output format (supported formats: stdout, html, csv) (optional).

Config Command​

The config command allows you to view and modify the configuration settings of the links tool. It provides options to display the current configuration, set new values, and save them to a file. See the Configuration section for more details.

Version Command​

The version command displays the current version of the links tool. Example:

links version

Help Command​

The help command displays help information for the tool and its commands. Example:

links help

or

links help inspect

This will display help information for the inspect command, including available flags and options.