armor CLI commands.
Exit Codes
armor auth
Authentication commands.armor auth login
Authenticate with AnomalyArmor.
Example:
armor auth status
Check authentication status.armor auth logout
Remove stored credentials.armor assets
Asset management commands.armor assets list
List assets with optional filters.
Example:
armor assets get
Get asset details.
Example:
armor freshness
Freshness monitoring commands.armor freshness summary
Get freshness summary.armor freshness list
List freshness status for all assets.
Example:
armor freshness get
Check freshness for a specific asset.armor freshness check
Check if an asset is fresh, fail if stale. Ideal for CI/CD pipelines.
Exit codes:
0- Data is fresh1- Data is stale3- Asset not found
armor freshness refresh
Trigger a freshness check for an asset.Requires an API key with
read-write or admin scope.armor schema
Schema drift monitoring commands.armor schema summary
Get schema changes summary.armor schema changes
List schema changes.
Example:
armor alerts
Alert management commands.armor alerts summary
Get alerts summary.armor alerts list
List alerts with filters.
Example:
armor api-keys
API key management commands. Requiresadmin scope.
armor api-keys list
List API keys.
Example:
armor api-keys create
Create a new API key.
Scopes:
read-only- Read assets, freshness, lineage, alertsread-write- Read + trigger refreshesadmin- Full access including key management
armor api-keys revoke
Revoke an API key.
Example:
armor tags
Tag management commands.armor tags list
List tags for an asset.
Example:
armor tags create
Create a tag on a database object.
Example:
armor tags apply
Apply multiple tags to multiple objects.
Example:
armor intelligence
AI intelligence commands.armor intelligence ask
Ask a question about your data.armor intelligence generate
Generate AI intelligence for an asset.Requires asset discovery to be run first.
armor jobs
Job monitoring commands.armor jobs status
Get status of an async job.armor metrics
Data quality metrics commands.armor metrics summary
Get metrics summary for an asset.armor metrics list
List metrics for an asset.
Example:
armor metrics get
Get metric details.armor metrics create
Create a new metric. Requiresread-write scope.
Example:
armor metrics capture
Trigger an immediate metric capture. Requiresread-write scope.
armor metrics delete
Delete a metric. Requiresread-write scope.
armor validity
Data validity rules commands.armor validity summary
Get validity summary for an asset.armor validity list
List validity rules for an asset.
Example:
armor validity get
Get validity rule details.armor validity create
Create a new validity rule. Requiresread-write scope.
Examples:
armor validity check
Trigger an immediate validity check. Requiresread-write scope.
0- Validation passed1- Validation failed (invalid records found)3- Rule not found
armor validity delete
Delete a validity rule. Requiresread-write scope.
armor referential
Referential integrity check commands.armor referential summary
Get referential summary for an asset.armor referential list
List referential checks for an asset.
Example:
armor referential get
Get referential check details.armor referential create
Create a new referential check. Requiresread-write scope.
Example:
armor referential execute
Execute a referential check. Requiresread-write scope.
0- Check passed (no orphans or within threshold)1- Check failed (orphans exceed threshold)3- Check not found
armor referential delete
Delete a referential check. Requiresread-write scope.
armor lineage
Data lineage commands.armor lineage get
Get lineage for an asset.
Example:
armor contract
ODCS contract export/import (see the Data Contracts guide for the ODCS background).armor contract pull
Export one or many contracts as ODCS YAML.--asset UUID: one asset, sync. Writes YAML to stdout unless-ogiven.--warehouse NAME: every contract in the warehouse, async job, writes zip to-o.--all: every contract in the account, async job, writes zip to-o.
-o, --output PATH: output file. Required for bulk scopes.--mode extended|odcs-pure: defaultextended.odcs-purestrips AnomalyArmor-specific fields for maximum ODCS interop.--include DOMAINS: comma-separated domain names to include (e.g.freshness,validity).--exclude DOMAINS: comma-separated domain names to exclude.--timeout SECONDS: async job poll timeout, default 600.
schema, freshness, validity, metrics, row_count, drift_monitors, schema_drift, alert_rules, destinations, blackouts.
Configuration
Config File
The CLI stores configuration in~/.armor/config.yaml:
