Sazabi
CLI

sazabi components

Command reference for sazabi components.

sazabi components — Manage status page components. Subcommands: list, get, scan, register, deregister, rename, reactivate, merge, relationships.

sazabi components

Manage status page components

sazabi components <subcommand>
sazabi components list  # List all components
sazabi components get <component-id>  # Get one component
sazabi components register --name "API Gateway"  # Register a component
sazabi components deregister <component-id>  # Deregister a component

sazabi components list

List components in the active project

sazabi components list [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--limitstringNoMaximum number of components to return (default: 50, max: 100)
--cursorstringNoPagination cursor from previous response
--include-deletedbooleanNoInclude deregistered components
sazabi components list  # List all components
sazabi components list --include-deleted  # Include deregistered components

sazabi components get

Get one component by ID

sazabi components get <component-id> [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
sazabi components get <component-id>  # Get one component

sazabi components scan

Detect component candidates in the working tree (propose-only)

sazabi components scan [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--dirstringNoDirectory to scan (default: current directory)
sazabi components scan  # Detect candidates and confirm which to register
sazabi components scan --json  # Print candidates only, register nothing

sazabi components register

Register or refresh a component

sazabi components register [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--namestringNoComponent name to register
--descriptionstringNoOptional component description
--originstringNoMachine provenance: 'code_detected' (inferred from code) or 'log_observed' (inferred from telemetry, the default)
sazabi components register --name "API Gateway"  # Register a component
sazabi components register --name "Checkout" --description "Checkout API and workflow"  # Register with description
sazabi components register --name "intake-consumer" --origin code_detected  # Register a component inferred from repository analysis

sazabi components deregister

Withdraw an observation, or preview and confirm a deregistration

sazabi components deregister <component-id> [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--confirm-preview-revisionstringNoExact componentRevisions JSON from the preview; omit to preview only
--request-idstringNoProject-scoped UUID idempotency key required for commit
--reasonstringNoDeregistration reason; optional for withdrawal and preview, required for commit
--confirm-canonical-groupbooleanNoConfirm the complete canonical group
sazabi components deregister <component-id>  # Withdraw an observation or preview the impact
sazabi components deregister <component-id> --confirm-preview-revision '{"<component-id>":7}' --request-id <uuid> --reason "replaced by the worker service"  # Commit the deregistration

sazabi components rename

Rename an active component

sazabi components rename <component-id> [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--namestringNoNew component name
--request-idstringNoProject-scoped UUID idempotency key
--reasonstringNoAudit reason for the rename

sazabi components reactivate

Preview or confirm component reactivation

sazabi components reactivate <component-id> [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--confirm-preview-revisionstringNoExact componentRevisions JSON from the preview; omit to preview only
--request-idstringNoProject-scoped UUID idempotency key required for commit
--reasonstringNoAudit reason required for commit
--deregistration-operation-idstringNoDeregistration operation ID returned by the preview
--notification-rule-idsstringNoComma-separated eligible notification rule IDs
--automation-binding-idsstringNoComma-separated eligible automation binding IDs
--relationship-idsstringNoComma-separated eligible relationship IDs

sazabi components merge

Preview or confirm present-day component consolidation

sazabi components merge [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--confirm-preview-revisionstringNoExact componentRevisions JSON from the preview; omit to preview only
--request-idstringNoProject-scoped UUID idempotency key required for commit
--reasonstringNoAudit reason required for commit
--sourcestringNoSource component ID
--targetstringNoTarget component ID
--policy-dispositionsstringNoExact non-equivalent policy disposition JSON
--confirm-policy-impactbooleanNoConfirm every previewed policy-scope change
sazabi components merge --source <component-id> --target <component-id>  # Preview only

sazabi components relationships

Inspect and edit component topology

sazabi components relationships <subcommand>

sazabi components relationships list

List component relationships

sazabi components relationships list [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--include-historicalbooleanNoInclude historically ended relationships

sazabi components relationships add

Add a component relationship

sazabi components relationships add [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--confirm-preview-revisionstringNoExact componentRevisions JSON from the preview; omit to preview only
--request-idstringNoProject-scoped UUID idempotency key required for commit
--reasonstringNoAudit reason required for commit
--sourcestringNoSource component ID
--targetstringNoTarget component ID
--typestringNoRelationship type: part_of or depends_on
--confirm-policy-impactbooleanNoConfirm the policy-scope delta shown by the preview
sazabi components relationships add --source <component-id> --target <component-id> --type part_of  # Preview a parent-child topology change

sazabi components relationships remove

End a component relationship

sazabi components relationships remove [options]
FlagTypeRequiredDescription
--tokenstringNoOverride token
--api-base-urlstringNoOverride API base URL
--jsonbooleanNoOutput as JSON
--confirm-preview-revisionstringNoExact componentRevisions JSON from the preview; omit to preview only
--request-idstringNoProject-scoped UUID idempotency key required for commit
--reasonstringNoAudit reason required for commit
--sourcestringNoSource component ID
--targetstringNoTarget component ID
--typestringNoRelationship type: part_of or depends_on
--confirm-policy-impactbooleanNoConfirm the policy-scope delta shown by the preview
sazabi components relationships remove --source <component-id> --target <component-id> --type part_of  # Preview a parent-child topology change