Skip to content
OpenPlanr Docs
GitHub (opens in a new tab)

openplanr report

Generate stakeholder report (sprint, weekly, executive, standup, retro, release) from OpenPlanr + GitHub

Usage
openplanr report [options] <type>
Arguments for openplanr report
ArgumentDescription
typeRequired

No description

Options for openplanr report
OptionDescription
--sprint <id>

sprint id, e.g. SPRINT-001

--days <n>

GitHub lookback days

Default: "7"

--no-github

skip GitHub commit/PR signals

--format <fmt>

markdown | html

Default: "markdown"

--output <dir>

directory under project

Default: .planr/reports

--stdout

print markdown to stdout instead of writing file

--lint

run report linter on generated markdown

--strict-evidence

fail if bullet claims under ## headings lack URLs or #issue references

Default: false

--push <targets>

comma-separated destinations: github, slack

--dry-run

with --push: show actions only

Default: false