Command line interface

publint [path] [options]

[path]: Pass a directory path to lint a specific directory, or pass a tarball file path to lint the tarball directly. If not provided, the current directory is linted.

[options]:

Flag	Description
--level	Type: 'suggestion' | 'warning' | 'error' Default: 'suggestion' Level of messages to log.
--pack	Type: 'auto' | 'npm' | 'yarn' | 'pnpm' | 'bun' | false Default: 'auto' Package manager to use for packing.
--strict	Type: boolean Default: false Report warnings as errors.

Check out the JavaScript API Options section for further information of each options.

Examples

# Run publint on the current directory
publint

# Run publint on a specific directory
publint ./dir

# Run publint on a tarball
publint ./mylib-1.0.0.tgz

# Ignore suggestions (only show warnings and errors)
publint --level warning

# Treat warnings as errors
publint --strict

# Use a specific package manager to pack the package (default auto-detects)
publint --pack npm