generated from coulomb/repo-seed
Establish Railiance Fabric graph model
This commit is contained in:
85
docs/discovery-queries.md
Normal file
85
docs/discovery-queries.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# Discovery Queries And Exports
|
||||
|
||||
Railiance Fabric includes a first CLI surface for inspecting local declaration
|
||||
graphs.
|
||||
|
||||
All commands accept a repo root, `fabric/` directory, or declaration files. When
|
||||
paths are omitted, commands read `./fabric`.
|
||||
|
||||
## Providers
|
||||
|
||||
List providers for a capability type or capability id:
|
||||
|
||||
```bash
|
||||
railiance-fabric providers runtime-secrets
|
||||
railiance-fabric providers railiance-platform.openbao.runtime-secrets
|
||||
```
|
||||
|
||||
Output columns:
|
||||
|
||||
```text
|
||||
provider_id service_id lifecycle environments interfaces
|
||||
```
|
||||
|
||||
## Consumers
|
||||
|
||||
List consumers of a capability type/id or interface type/id:
|
||||
|
||||
```bash
|
||||
railiance-fabric consumers runtime-secrets
|
||||
railiance-fabric consumers railiance-platform.openbao.kv-v2
|
||||
```
|
||||
|
||||
Output columns:
|
||||
|
||||
```text
|
||||
consumer_service_id dependency_id requires provider_capability_id provider_interface_id status
|
||||
```
|
||||
|
||||
## Dependency Path
|
||||
|
||||
Show dependency paths for a service:
|
||||
|
||||
```bash
|
||||
railiance-fabric dependency-path flex-auth.api
|
||||
```
|
||||
|
||||
This walks declared dependencies and binding assertions recursively through
|
||||
provider services.
|
||||
|
||||
## Unresolved Dependencies
|
||||
|
||||
Show dependencies with no matching provider or a `missing`/`disputed` binding:
|
||||
|
||||
```bash
|
||||
railiance-fabric unresolved
|
||||
```
|
||||
|
||||
## Blast Radius
|
||||
|
||||
Show consumers affected by an interface type or interface id:
|
||||
|
||||
```bash
|
||||
railiance-fabric blast-radius openbao-kv-v2-mount
|
||||
railiance-fabric blast-radius railiance-platform.openbao.kv-v2
|
||||
```
|
||||
|
||||
## Exports
|
||||
|
||||
Export the graph as JSON:
|
||||
|
||||
```bash
|
||||
railiance-fabric export --format json
|
||||
```
|
||||
|
||||
Export the graph as Mermaid:
|
||||
|
||||
```bash
|
||||
railiance-fabric export --format mermaid
|
||||
```
|
||||
|
||||
The JSON export has two top-level arrays:
|
||||
|
||||
- `nodes`: service, capability, interface, dependency, and binding nodes
|
||||
- `edges`: graph relationships such as `provides`, `exposes`,
|
||||
`available_via`, `consumes`, `binds:<status>`, and `uses_interface`
|
||||
Reference in New Issue
Block a user