Command reference

LinSentry Command Reference

Detailed usage and examples for every public command-line option.

Basic syntax

linsentry-community [options]
linsentry-pro [options]
linsentry-beta [options]

Community and Pro are separate binaries. Beta is a separate pre-release binary. Some options are only registered when the selected edition has the matching capability, so an option shown for Pro or Beta may be rejected by Community as an unknown flag.

Running LinSentry with sudo is recommended for the most complete assessment. LinSentry's normal diagnostics are read-only and do not automatically remediate findings.

Common examples

Check version

./linsentry-community --version

Run full Community assessment

sudo ./linsentry-community --report

Create PDF and text

sudo ./linsentry-community --report --text-report

Choose output directory

sudo ./linsentry-community --report --report-dir ~/reports

Skip website checks

sudo ./linsentry-community --report --skip-websites

Skip containers

sudo ./linsentry-community --report --skip-containers

Run help without ANSI colors

./linsentry-community --no-color --help

Show edition matrix

./linsentry-community --edition-matrix

Show platform support

./linsentry-community --support-matrix

Options

Each option below matches the public flag registration and edition capability boundaries.

--helpShow command-line help for the selected binary.--versionShow version, edition, commit, build date, architecture, dirty-tree state, and report schema.--build-infoShow detailed build metadata.--reportGenerate a local diagnostic PDF report non-interactively.--text-reportCreate a plain-text report in addition to the PDF report.--report-dirChoose the report output directory.--skip-containersSkip container runtime diagnostics.--skip-websitesSkip automatic hosted website diagnostics during general report generation.--skip-mailSkip automatic mail diagnostics during general report generation.--skip-databaseSkip automatic database diagnostics during general report generation.--edition-matrixPrint edition feature support status.--support-matrixPrint platform support status.--no-colorDisable ANSI color output.--debugEnable debug logging to stderr.--foundation-onlyGenerate report structure without running diagnostics.--validation-summaryWrite a bounded real-run validation summary JSON file.--websiteRun focused website diagnostics for a domain.--deep-websitesRun deep website diagnostics for every tested domain in automatic website assessment.--max-websitesSet the maximum number of domains to run public website tests for.--website-concurrencySet maximum concurrent website assessments.--combined-reportCombine server and website diagnostics when used with --website --report.--allow-private-targetAllow website and mail endpoint diagnostics for private or local targets.--mail-domainRun focused mail delivery diagnostics for a domain.--mail-endpointRun focused mail protocol diagnostics for an endpoint.--mail-queueRun focused outbound mail queue diagnostics.--databaseRun focused local database service diagnostics.--format text|jsonSelect text or JSON output for structured inspection views.--jsonShortcut for JSON output on structured inspection views.--export-to-pleskLegacy Beta-only option to export generated report files to a selected Plesk subscription File Manager directory.--plesk-subscriptionSelect the Plesk subscription domain or identifier for --export-to-plesk.--refresh-package-metadataLegacy Beta-only option to run package metadata refresh before package update checks.

`--help`

CommunityProBeta

Show command-line help for the selected binary.

./linsentry-community --help

The generated help output lists the flags registered for that edition. It does not run diagnostics or create reports.

`--version`

CommunityProBeta

Show version, edition, commit, build date, architecture, dirty-tree state, and report schema.

./linsentry-community --version

No diagnostics run. Use this when reporting installation or compatibility questions.

`--build-info`

CommunityProBeta

Show detailed build metadata.

./linsentry-community --build-info

This includes identity data plus Go version and CGO release-build status. No diagnostics run.

`--report`

CommunityProBeta

Generate a local diagnostic PDF report non-interactively.

sudo ./linsentry-community --report

Runs diagnostics available in the edition, writes a PDF report, and prints the path. Use sudo for fuller evidence.

`--text-report`

CommunityProBeta

Create a plain-text report in addition to the PDF report.

sudo ./linsentry-community --report --text-report

Use with --report where the current report path supports text output.

`--report-dir`

CommunityProBeta

Choose the report output directory.

sudo ./linsentry-community --report --report-dir /tmp/linsentry-report

LinSentry validates the directory before writing reports and may restore ownership after sudo.

`--skip-containers`

CommunityProBeta

Skip container runtime diagnostics.

sudo ./linsentry-community --report --skip-containers

Community skips basic container diagnostics. Pro and Beta skip basic and advanced container collection.

`--skip-websites`

CommunityProBeta

Skip automatic hosted website diagnostics during general report generation.

sudo ./linsentry-community --report --skip-websites

Community skips basic website inventory and HTTP/TLS checks. Pro and Beta skip advanced website correlation too.

`--skip-mail`

CommunityProBeta

Skip automatic mail diagnostics during general report generation.

sudo ./linsentry-community --report --skip-mail

Community skips basic mail detection. Pro and Beta skip full mail diagnostics in the automatic path.

`--skip-database`

CommunityProBeta

Skip automatic database diagnostics during general report generation.

sudo ./linsentry-community --report --skip-database

Community skips basic database detection. Pro and Beta skip full database diagnostics in the automatic path.

`--edition-matrix`

CommunityProBeta

Print edition feature support status.

./linsentry-community --edition-matrix

No diagnostics run. Output is generated from LinSentry's edition feature manifest.

`--support-matrix`

CommunityProBeta

Print platform support status.

./linsentry-community --support-matrix

No diagnostics run. Output distinguishes validated, experimental, best-effort, and unsupported targets.

`--no-color`

CommunityProBeta

Disable ANSI color output.

./linsentry-community --no-color --help

Useful for plain logs, limited terminals, and copied support output. NO_COLOR has the same default effect.

`--debug`

CommunityProBeta

Enable debug logging to stderr.

sudo ./linsentry-community --debug --report

Debug output can include environment-specific details. Redact operational details before sharing.

`--foundation-only`

CommunityProBeta

Generate report structure without running diagnostics.

./linsentry-community --foundation-only --report

Useful for report structure checks, not for real server assessment.

`--validation-summary`

ProBeta

Write a bounded real-run validation summary JSON file.

sudo ./linsentry-pro --report --validation-summary /tmp/linsentry-validation.json

Records build identity, platform metadata, diagnostic counts, report status, exit code, and truncation indicators. Not registered in Community.

`--website`

ProBeta

Run focused website diagnostics for a domain.

sudo ./linsentry-pro --website example.com

With --report it creates a focused website PDF report. Use --combined-report to include server diagnostics.

`--deep-websites`

ProBeta

Run deep website diagnostics for every tested domain in automatic website assessment.

sudo ./linsentry-pro --report --deep-websites

Affects the general report path, increases local website analysis where evidence is available, and remains read-only.

`--max-websites`

ProBeta

Set the maximum number of domains to run public website tests for.

sudo ./linsentry-pro --report --max-websites 100

Default is 500. Use this to bound assessment size on large hosting systems.

`--website-concurrency`

ProBeta

Set maximum concurrent website assessments.

sudo ./linsentry-pro --report --website-concurrency 5

Default is 10. Lower it on small or resource-constrained servers.

`--combined-report`

ProBeta

Combine server and website diagnostics when used with --website --report.

sudo ./linsentry-pro --website example.com --report --combined-report

Without this flag, the focused website report contains website diagnostics only. Not registered in Community.

`--allow-private-target`

ProBeta

Allow website and mail endpoint diagnostics for private or local targets.

sudo ./linsentry-pro --website internal.example --allow-private-target

Use only when you intentionally diagnose a private target you control.

`--mail-domain`

ProBeta

Run focused mail delivery diagnostics for a domain.

sudo ./linsentry-pro --mail-domain example.com

With --report, LinSentry also creates a mail-focused PDF report; combine with --text-report for text.

`--mail-endpoint`

ProBeta

Run focused mail protocol diagnostics for an endpoint.

sudo ./linsentry-pro --mail-endpoint mail.example.com

Uses mail safety controls and respects --allow-private-target. LinSentry does not authenticate to mail services.

`--mail-queue`

ProBeta

Run focused outbound mail queue diagnostics.

sudo ./linsentry-pro --mail-queue

Read-only and can benefit from sudo because mail queue visibility is often privileged.

`--database`

ProBeta

Run focused local database service diagnostics.

sudo ./linsentry-pro --database

With --report, it creates a database-focused PDF report. Current focused database path creates PDF only.

`--format text|json`

CommunityProBeta

Select text or JSON output for structured inspection views.

./linsentry-community --format json diagnostics containers

Useful with inspection commands such as diagnostics, findings, websites, containers, compose, tls, coverage, and cleanup.

`--json`

CommunityProBeta

Shortcut for JSON output on structured inspection views.

./linsentry-community --json findings list

Equivalent to --format json for supported inspection views. It is not a report format switch.

`--export-to-plesk`

Beta

Legacy Beta-only option to export generated report files to a selected Plesk subscription File Manager directory.

sudo ./linsentry-beta --report --export-to-plesk --plesk-subscription example.com

Requires --report and --plesk-subscription. Not registered in Community or Pro.

`--plesk-subscription`

Beta

Select the Plesk subscription domain or identifier for --export-to-plesk.

sudo ./linsentry-beta --report --export-to-plesk --plesk-subscription example.com

Only meaningful with --export-to-plesk. Missing subscription information causes an export-specific error.

`--refresh-package-metadata`

Beta

Legacy Beta-only option to run package metadata refresh before package update checks.

sudo ./linsentry-beta --report --refresh-package-metadata

Not available in Community or Pro. It may update the local package manager metadata cache.

Root and sudo guidance

LinSentry can run without root, but some checks may be limited without privileges. Use sudo for the most complete assessment of logs, queues, generated configuration, service state, Plesk details, and Docker evidence.

Output files

--report creates a PDF report. --text-report creates a matching plain-text report where supported. Use --report-dir to choose the destination directory.

Exit codes

0: completed successfully without critical findings.
1: application failure, invalid arguments, no writable report directory, or report generation failure.
2: completed with one or more critical findings.
3: completed but diagnostic coverage was materially limited.
4: invalid or unsafe website or mail target.
5: private target requires explicit permission.
6: requested website, mail domain, or endpoint could not be discovered.
7: Beta Plesk report export failed or export flags were invalid.

Safety and privacy notes

No automatic remediation is performed by normal diagnostics.
No telemetry requirement or automatic report upload is used.
Reports stay local unless you choose to share them.
Reports and debug output can contain server-specific details.

Current language scope

Current application language: English. Website: English, German, French, Spanish and Dutch.