veirox report

Manage generated reports

Synopsis

veirox report <subcommand> [args] [flags]

Description

Manage generated reports

Subcommands

CommandDescription
veirox report createCreate a report
veirox report info <report-id>Show report content
veirox report listList reports
veirox report pdf <report-id>Render the report as PDF
veirox report rm <report-id>Delete a report

veirox report create

Create a report

FlagTypeDefaultDescription
--content-htmlstringhtml content (inline)
--content-mdstringmarkdown content (inline)
--session-idstringbind to session uuid
--task-idstringbind to task uuid
--titlestringreport title
veirox report create --title 'Q1 Postmortem' --content-md ./postmortem.md

veirox report info <report-id>

Show report content

veirox report info 00000000-0000-4000-8000-000000000001

veirox report list

List reports

FlagTypeDefaultDescription
--limitint0page size
--offsetint0pagination offset
--session-idstringfilter by session uuid
--task-idstringfilter by task uuid
veirox report list --task-id <uuid>

veirox report pdf <report-id>

Render the report as PDF

veirox report pdf 00000000-0000-4000-8000-000000000001

veirox report rm <report-id>

Delete a report

FlagTypeDefaultDescription
--yesboolfalseconfirm deletion
veirox report rm 00000000-0000-4000-8000-000000000001 --yes

Exit codes

CodeMeaning
0Success.
1Generic error (network, API 5xx).
2Validation error (bad flag, missing required arg).
3Unauthenticated — run veirox login or set VEIROX_API_KEY.
4Not found (resource does not exist in this project).
5Permission denied (your role / API key lacks the scope).

See also