docs consolidation
This commit is contained in:
60
docs/modules/cli/guides/commands/db.md
Normal file
60
docs/modules/cli/guides/commands/db.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# stella db - Command Guide
|
||||
|
||||
The `stella db` command group triggers Concelier database operations via backend jobs (connector stages, merge reconciliation, exports).
|
||||
|
||||
These commands are operational: they typically require Authority authentication and appropriate Concelier scopes.
|
||||
|
||||
## Commands
|
||||
|
||||
### db fetch
|
||||
|
||||
Trigger a connector stage (`fetch`, `parse`, or `map`) for a given source.
|
||||
|
||||
```bash
|
||||
stella db fetch --source osv --stage fetch
|
||||
stella db fetch --source osv --stage parse
|
||||
stella db fetch --source osv --stage map
|
||||
```
|
||||
|
||||
Options:
|
||||
- `--source` (required): connector identifier (for example `osv`, `redhat`, `ghsa`).
|
||||
- `--stage` (optional): `fetch`, `parse`, or `map` (defaults to `fetch`).
|
||||
- `--mode` (optional): connector-specific mode (for example `init`, `resume`, `cursor`).
|
||||
|
||||
### db merge
|
||||
|
||||
Run canonical merge reconciliation.
|
||||
|
||||
```bash
|
||||
stella db merge
|
||||
```
|
||||
|
||||
### db export
|
||||
|
||||
Run Concelier export jobs.
|
||||
|
||||
```bash
|
||||
stella db export --format json
|
||||
stella db export --format trivy-db --delta
|
||||
```
|
||||
|
||||
Options:
|
||||
- `--format` (optional): `json` or `trivy-db` (defaults to `json`).
|
||||
- `--delta` (optional): request a delta export when supported.
|
||||
- `--publish-full` / `--publish-delta` (optional): override whether exports are published (true/false).
|
||||
- `--bundle-full` / `--bundle-delta` (optional): override whether offline bundles include full/delta exports (true/false).
|
||||
|
||||
## Common setup
|
||||
|
||||
Point the CLI at the Concelier base URL:
|
||||
```bash
|
||||
export STELLAOPS_BACKEND_URL="https://concelier.example.internal"
|
||||
```
|
||||
|
||||
Authenticate:
|
||||
```bash
|
||||
stella auth login
|
||||
```
|
||||
|
||||
See: `docs/10_CONCELIER_CLI_QUICKSTART.md` and `docs/modules/concelier/operations/authority-audit-runbook.md`.
|
||||
|
||||
Reference in New Issue
Block a user