64 lines
3.0 KiB
Markdown
64 lines
3.0 KiB
Markdown
# StellaOps CLI
|
||
|
||
The `stella` CLI is the operator-facing Swiss army knife for scans, exports, policy management, offline kit operations, and automation scripting.
|
||
|
||
## Responsibilities
|
||
- Deliver deterministic verbs for scan, diff, export, policy, and observability operations.
|
||
- Handle interactive and non-interactive authentication via Authority (device code, client credentials).
|
||
- Support offline kit workflows including bundle verification and seed installation.
|
||
- Expose JSON outputs suitable for CI parity and golden tests.
|
||
|
||
## Key components
|
||
- `StellaOps.Cli` native AOT host.
|
||
- Shared helpers in `StellaOps.Cli.Core`.
|
||
- Restart-time plug-ins under `StellaOps.Cli.Plugins.*`.
|
||
|
||
## Integrations & dependencies
|
||
- Authority for token exchange.
|
||
- Backend APIs (Scanner, Policy, Export Center, Notify).
|
||
- Offline kit bundles and local keychain/DPoP storage.
|
||
|
||
## Operational notes
|
||
- Deterministic output fixtures under `src/Cli/StellaOps.Cli.Tests`.
|
||
- Versioned command docs in `docs/modules/cli/guides`.
|
||
- Plugin catalogue in `plugins/cli/**` (restart-only).
|
||
|
||
## Related resources
|
||
- ./guides/20_REFERENCE.md
|
||
- ./guides/cli-reference.md
|
||
- ./guides/policy.md
|
||
|
||
## Backlog references
|
||
- DOCS-CLI-OBS-52-001 / DOCS-CLI-FORENSICS-53-001 in ../../TASKS.md.
|
||
- CLI-CORE-41-001 epic in `src/Cli/StellaOps.Cli/TASKS.md`.
|
||
|
||
## Current workstreams (Q4 2025)
|
||
- Active docs sprint: `docs/implplan/SPRINT_0316_0001_0001_docs_modules_cli.md` — normalised sprint naming, doc sync, and upcoming ops/runbook refresh.
|
||
|
||
## Epic alignment
|
||
- **Epic 2 – Policy Engine & Editor:** deliver deterministic policy authoring, simulation, and explain verbs.
|
||
- **Epic 4 – Policy Studio:** integrate registry/promotion workflows, approvals, and lint tooling.
|
||
- **Epic 6 – Vulnerability Explorer:** surface triage and ledger operations.
|
||
- **Epic 10 – Export Center:** orchestrate export requests, verification, and Offline Kit automation.
|
||
- **Epic 11 – Notifications Studio:** manage notification authoring/previews from the command line.
|
||
|
||
## Implementation Status
|
||
|
||
**Epic Milestones:**
|
||
- Epic 2 (Policy Engine & Editor) – Deliver deterministic policy verbs, simulation, and explain outputs
|
||
- Epic 4 (Policy Studio) – Add registry/promotion workflows, lint tooling, and approvals UX
|
||
- Epic 6 (Vulnerability Explorer) – Integrate ledger/triage operations
|
||
- Epic 10 (Export Center) – Automate export verification and Offline Kit flows
|
||
- Epic 11 (Notifications Studio) – Manage rule/channel authoring and previews via CLI
|
||
|
||
**Key Responsibilities:**
|
||
- Deterministic verbs for scan, diff, export, policy, and observability operations
|
||
- Interactive and non-interactive authentication via Authority (device code, client credentials)
|
||
- Offline kit workflows including bundle verification and seed installation
|
||
- JSON outputs suitable for CI parity and golden tests
|
||
|
||
**Operational Focus:**
|
||
- Maintain deterministic output fixtures and versioned command documentation
|
||
- Support plugin catalogue for restart-only extensions
|
||
- Keep documentation aligned with active sprint outcomes
|