Skip to content

rai adapter

Inspect and validate registered adapters. Adapters connect RaiSE to external services (Jira, Confluence, GitHub, etc.) via typed Protocol contracts.

List all registered adapters by entry point group. Shows each group with its registered adapters and source package.

FlagShortDescription
--format-fOutput format: human, json. Default: human
Terminal window
rai adapter list
rai adapter list --format json

Validate adapters against their Protocol contracts. Loads each registered adapter and checks compliance via isinstance() against its @runtime_checkable Protocol.

FlagShortDescription
--format-fOutput format: human, json. Default: human
Terminal window
rai adapter check
rai adapter check --format json

Validate a declarative YAML adapter config. Checks that the YAML file conforms to DeclarativeAdapterConfig schema.

ArgumentDescription
FILEPath to YAML adapter config file (required)
Terminal window
rai adapter validate .raise/adapters/github.yaml

Show configuration status for known adapters. Checks that required config files exist and environment variables are set.

FlagShortDescription
--format-fOutput format: human, json. Default: human
Terminal window
rai adapter status
rai adapter status --format json

See also: rai backlog, rai docs