comp reports¶

NAME¶

phyware comp reports — create, list, retrieve, and download compliance audit reports.

SYNOPSIS¶

phyware comp reports create   [OPTIONS]
phyware comp reports list     [OPTIONS]
phyware comp reports get      [OPTIONS] <REPORT_ID>
phyware comp reports download [OPTIONS] <REPORT_ID>

DESCRIPTION¶

create¶

Generates a new compliance audit report for the active tenant.

list¶

Lists all compliance audit reports.

get¶

Returns metadata for a single report.

download¶

Downloads a report as plain text to stdout or a file.

OPTIONS¶

Flag	Type	Required	Default	Env
`--url`	string	No	`http://localhost:8001`	`PHYCOMP_URL`
`--api-key`	string	No	—	`PHYCOMP_API_KEY`
`--output`	enum	No	`table`	—

| --tenant-id | string | No | (active) | — | | --format | enum | No | pdf | — | | --file | path | No | — | — |

ARGUMENTS¶

Name	Required	Description
`REPORT_ID`	Yes (get/download)	Unique report identifier

INPUT¶

None.

OUTPUT¶

Field	Type	Description
`id`	string	Report identifier
`status`	string	`pending` / `ready` / `failed`
`url`	string	Download URL (get/download)

EXIT CODES¶

Code	Meaning
`0`	Success
`1`	Generic / connection error
`2`	Authentication / authorisation error
`3`	Resource not found
`4`	Validation error
`5`	Server-side error

EXAMPLES¶

# Create a report
phyware comp reports create

# List all reports
phyware comp reports list --output json

# Get a specific report
phyware comp reports get rep_abc123

# Download a report to a file
phyware comp reports download rep_abc123 --file report.txt

# Create and wait for report then download
REPORT_ID=$(phyware comp reports create -o json | jq -r '.report.id')
phyware comp reports download "$REPORT_ID" --file audit.txt

AGENT NOTES¶

create is asynchronous — poll get until status is ready before downloading. Requires write:reports (create) or read:reports (list/get/download) scope.

ERRORS¶

Code	Message	Remediation
`NOT_FOUND`	Report not found	Check `REPORT_ID`
`FORBIDDEN`	Insufficient scope	Ensure `read:reports`
`NOT_READY`	Report still pending	Poll `get` and retry