comp evaluate¶
NAME¶
phyware comp evaluate — trigger compliance evaluation for a tenant.
SYNOPSIS¶
DESCRIPTION¶
Submits an evaluation job to PhyComp. The service evaluates all registered rules against the ingested event data and records any violations. The job runs asynchronously; use comp violations list to view results.
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) | — | | --rule-id | string | No | (all) | — | | --async | bool | No | false | — |
ARGUMENTS¶
None.
INPUT¶
None.
OUTPUT¶
| Field | Type | Description |
|---|---|---|
job_id | string | Evaluation job identifier |
status | string | submitted / running |
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¶
# Trigger evaluation for the active tenant
phyware comp evaluate
# Evaluate a specific tenant
phyware comp evaluate --tenant-id ten_abc123
# Evaluate a single rule
phyware comp evaluate --rule-id rule_gdpr_001
# Run in async mode (don't wait for completion)
phyware comp evaluate --async
# Capture job ID for polling
JOB_ID=$(phyware comp evaluate -o json | jq -r '.job_id')
AGENT NOTES¶
After ingesting a batch of events, call evaluate to trigger compliance checks. Then poll violations list for new findings. Requires write:evaluations scope. For large datasets, use --async and poll via the job API.
SEE ALSO¶
ERRORS¶
| Code | Message | Remediation |
|---|---|---|
FORBIDDEN | Insufficient scope | Ensure write:evaluations |
NOT_FOUND | Tenant not found | Check --tenant-id |
CONFLICT | Evaluation running | Wait for current job to finish |