`veirox entity`

Manage agent context entities (memory, knowledge, runbook, …)

Synopsis

veirox entity <subcommand> [args] [flags]

CRUD over the unified /api/agent-entities/{kind} surface. Supported kinds: .

Command	Description
`veirox entity create`	Create a new entity
`veirox entity delete`	Soft-delete an entity
`veirox entity get`	Get one entity by UUID or slug
`veirox entity list`	List entities of a given kind
`veirox entity update`	Update an entity (version-checked)

Create a new entity

Flag	Type	Default	Description
`--body-file`	string	—	Path to a file whose contents become the body
`--description`	string	—	Short description
`--kind`	string	—	Entity kind
`--metadata`	string	—	JSON object — kind-specific metadata fields
`--slug`	string	—	URL-safe slug (auto-derived from title if omitted)
`--title`	string	—	Human-readable title

veirox entity create --kind incident --title 'API 500s' --body-file ./report.md --metadata '{"severity":"high"}'

Soft-delete an entity

Flag	Type	Default	Description
`--kind`	string	—	Entity kind
`--ref`	string	—	UUID or slug to delete

veirox entity delete --kind memory --ref auth-quirks

Get one entity by UUID or slug

Flag	Type	Default	Description
`--kind`	string	—	Entity kind
`--ref`	string	—	UUID or slug

veirox entity get --kind runbook --ref deploy-checklist

List entities of a given kind

Flag	Type	Default	Description
`--kind`	string	memory	Entity kind (one of )
`--limit`	int	0	Page size (backend caps at 500)
`--offset`	int	0	Offset for pagination

veirox entity list --kind memory --limit 20

Update an entity (version-checked)

Flag	Type	Default	Description
`--body-file`	string	—	Path to a file whose contents become the new body
`--description`	string	—	New description (omit to leave unchanged)
`--kind`	string	—	Entity kind
`--metadata`	string	—	JSON object — overwrites the metadata field
`--ref`	string	—	UUID or slug of the entity to update
`--title`	string	—	New title (omit to leave unchanged)
`--version`	int	0	Last-seen version — backend returns 409 on mismatch

veirox entity update --kind runbook --ref deploy-checklist --version 3 --metadata '{"version":"1.1.0"}'

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