Skip to content

agnify report

Create a report from a body file and print its URL.

Usage

Terminal window
agnify report create [OPTIONS]

Options

FlagDescription
--title, -tReport title.
--htmlHTML body file, or ’-’ for stdin.
--markdownMarkdown body file, or ’-’ for stdin.
--description, -d
--dataJSON file of baked aggregates.
--refDeclare a source: kind:id[=label]. Repeatable.
--visibilityprivate

Show a report’s metadata, or its raw source with —body.

Usage

Terminal window
agnify report get [OPTIONS] REPORT_ID

Arguments

NameDescription
REPORT_IDReport id, or a unique id prefix (≥4 chars).

Options

FlagDescription
--revision, -r
--bodyPrint the raw source instead of metadata.

List the active org’s reports.

Usage

Terminal window
agnify report ls [OPTIONS]

Options

FlagDescription
--mineOnly reports you own.

List a report’s retained revisions, newest first.

Usage

Terminal window
agnify report revisions REPORT_ID

Arguments

NameDescription
REPORT_IDReport id, or a unique id prefix (≥4 chars).

Delete a report.

Usage

Terminal window
agnify report rm REPORT_ID

Arguments

NameDescription
REPORT_IDReport id, or a unique id prefix (≥4 chars).

Update a report — a new revision when the body, data or refs change.

Usage

Terminal window
agnify report update [OPTIONS] REPORT_ID

Arguments

NameDescription
REPORT_IDReport id, or a unique id prefix (≥4 chars).

Options

FlagDescription
--htmlNew HTML body file, or ’-’.
--markdownNew markdown body file, or ’-’.
--title, -t
--description, -d
--dataJSON file of baked aggregates.
--refReplace the declared sources: kind:id[=label]. Repeatable.
--if-versionFail with 409 unless the report is still at this version.

Lint a body against the report sandbox — no HTTP, no upload.

Usage

Terminal window
agnify report validate PATH

Arguments

NameDescription
PATHBody file to lint, or ’-’ for stdin.