CLI reference

Command syntax and options for the Pharos CLI.

Command

pharos <package>@<version> [options]

The package spec must include an exact version.

Options

OptionDescription
-p, --path <PATH>Directory to search. Defaults to the current directory.
-r, --recursiveSearch subdirectories for additional lockfiles.
--jsonPrint a machine-readable JSON report instead of human-readable text.

Examples

Check the current directory:

pharos minimist@1.2.5

Check a specific project:

pharos qs@6.13.0 --path ./my-app

Search nested projects:

pharos semver@7.0.0 --path ~/projects --recursive

Emit JSON:

pharos qs@6.13.0 --path ./my-app --json