Presswork

Maintain and validate repository documentation for software agents with versioned policy, read-only Checks, and actionable outcomes.

Presswork keeps repository documentation for software agents aligned with one explicit, versioned policy. It discovers the documentation in a Repository Root, evaluates it without changing it, and reports policy Violations separately from operations it could not complete.

Run your first Check

If Presswork is already installed, run this command from anywhere inside a Git repository to check the documentation selected by the Basic Profile or the root presswork.json file. Otherwise, start with Getting Started for installation and the first report.

presswork check

The Check Report distinguishes a complete Check with no Violations, a complete Check with Violations, and an incomplete Check with Operational Diagnostics. Getting Started covers installation, the first report, and explicit Repository Root selection.

Choose your path

Complete a task

• Check a repository runs Validation in a repository and interprets the outcome.
• Configuring Presswork creates and validates presswork.json.
• Create a Document Draft lists Document Types and follows their Creation Policies.
• Generate agent guidance renders repository-specific guidance for documentation work.

Use the Reference for Presswork Configuration, Built-in Profiles, CLI, ESM API, Check Report, and Rules.