Skip to main content

sentrix requirements

Generate and review product requirements documents.

sentrix requirements

Generate and review product requirements documents. This command is also available as sentrix prd.

Subcommands#

sentrix requirements new#

Generate a new requirements document using AI.

Aliases: write, create

Usage#

bash
sentrix requirements new --app <app> --description <description> [--draft] [--frontmatter-only]

Options#

FlagTypeRequiredDefaultDescription
--appstringYesTarget app name (e.g., website, ai-ui, ai-api).
--descriptionstringYesNatural language description of the requirements.
--draftboolNofalseSave to plans/backlog/<app>/ instead of the active plans directory.
--frontmatter-onlyboolNofalseWrite only YAML frontmatter and leave the Markdown body empty. This does not change existing --draft or --dry-run behavior.

Behavior#

  • sentrix requirements new uses an inline prompt bundled with the CLI. It does not depend on an installed /sentrix-requirements-new file under .claude/commands/.
  • Sentrix resolves the agent for this flow from command-specific configuration rather than a runtime-default provider.
  • Sentrix still generates the normal AI draft to derive metadata such as title, summary, category, priority, and issue name.
  • When --frontmatter-only is set, any written file contains only YAML frontmatter plus an empty body.
  • Without --frontmatter-only, Sentrix writes the full AI-generated requirements body based on description.

Examples#

Create active requirements:

bash
sentrix requirements new --app website --description "Contact form with email validation and spam protection"

Create draft requirements in the backlog:

bash
sentrix requirements new --app website --description "Blog search functionality" --draft

Create a frontmatter-only requirements file for manual authoring:

bash
sentrix requirements new --app website --description "Partner integrations settings page" --frontmatter-only

Pass a multi-line description:

bash
DESC=$(cat <<'EOF'
Write your multi-line description of
the requirements here.
EOF
)
sentrix requirements new --app "app-name-goes-here" --description "$DESC"

sentrix requirements review#

Review an existing requirements document using AI. This command provides structured feedback without modifying the file.

Usage#

bash
sentrix requirements review <target>

Arguments#

ArgumentTypeRequiredDescription
targetpathYesPath to a directory containing 00-requirements.md, or a direct path to the requirements file.

Requirements in plans/backlog/ cannot be reviewed — they must be activated first.

Example#

bash
sentrix requirements review plans/website/2026-02/feature-contact-form/

sentrix requirements delete#

Delete a requirements document and all associated plan files.

Usage#

bash
sentrix requirements delete <target>

Arguments#

ArgumentTypeRequiredDescription
targetpathYesPath to a directory containing 00-requirements.md, or a direct path to the requirements file.

Requirements in plans/backlog/ cannot be deleted using this command — they must be activated first. Requirements assigned to an initiative (with an initiative_id) also cannot be deleted.

Behavior#

  • Deletes the requirements file and all child plan files in the same directory
  • Syncs deletions to the Sentrix API
  • Removes the directory if it is empty after deletion
  • Rejects deletion when any plan or requirement has blocked_by references crossing the directory boundary (in either direction)

Use --dry-run (-n) to preview what would be deleted without writing:

bash
sentrix requirements delete plans/website/2026-02/feature-contact-form/ --dry-run

Example#

bash
sentrix requirements delete plans/website/2026-02/feature-contact-form/