Getting Started

Install Presswork, run a first Check against a Git repository, recognize each report outcome, and select an explicit Repository Root.

You need Node.js 24 or later and a Git repository.

1. Install Presswork

Install the presswork executable globally with npm.

npm install --global presswork

Confirm that the executable is available.

presswork --version

The command prints the installed Presswork version and exits 0.

2. Run the first Check

From anywhere inside the Git repository, run a Check.

presswork check

Presswork selects the nearest ancestor containing a .git file or directory as the Repository Root. If that root has no presswork.json, the complete Basic Profile at basic@1 applies.

The first line of a produced report is either Check complete or Check incomplete. A complete Check with no Violations exits 0.

If the report contains Violations, the Check is complete but exits 1. Each Violation identifies the source, failed Rule, relevant destination, and recovery guidance.

If the report contains an Operational Diagnostic, the Check is incomplete and exits 2. The report can retain Violations found during completed evaluations.

3. Select the Repository Root when needed

Pass a relative or absolute path when the current directory should not control Repository Root discovery.

presswork check --root /path/to/repository

Relative paths resolve from the current directory. An invalid explicit root does not fall back to an ancestor.

You have completed the tutorial when Presswork produces your first Check Report and you can identify whether it is complete, whether it contains Violations, and whether an Operational Diagnostic prevented part of the Check. Violations can remain at this point.

Use Check a Repository to remediate the report, look up repository settings in the Presswork Configuration reference, create a Document Draft, or use the Check Report reference to integrate report data.