Skip to content
Esc
↑↓navigate↵open⌘Jpreview
On this page

Reference

Choose the exact Presswork contract for configuration, CLI commands, the ESM API, Check Reports, or stable Rule identifiers.

Presswork Configuration

Look up presswork.json, paths, Document Types, Index Policies, and Agent Skill guidance.

Built-in Profiles

Compare the complete policies distributed with Presswork.

CLI

Look up commands, arguments, options, help, streams, color behavior, and exit status.

ESM API

Use the public Effect service, schemas, and TypeScript types.

Check Report

Look up complete and incomplete report data, fields, ordering, serialization, streams, and exit status.

Rules

Look up stable Rule identifiers, examples, and enabling policies.

Understand or complete a task

Read Concepts to understand how the contracts fit together or Profiles for Profile selection semantics. For procedures, use Check a repository, Configuring Presswork, Create a Document Draft, or Generate agent guidance.