Skip to content

Commit e4aa95d

Browse files
committed
docs(roadmap): mark shipped items as complete
Three items previously listed under Remaining are already shipped; recording them so the roadmap reflects reality: * Progress indicators — argus/cli.py::Spinner provides phase-aware scan progress with --no-spinner opt-out (commit 2c46fce). * pull_policy evaluation — ArgusConfig.execution.pull_policy accepts always | if-not-present | never; engine and container_runtime honor it. * Shared findings renderer — argus/core/findings_view.py is the shared module. TUI imports from argus/viewers/terminal/app.py; browser interface imports from argus/viewers/browser/app.py and log_view.py. Portal can adopt the same module if/when it wants identical per-finding layout. Also split the docs/view-terminal.md item: quickstart (install, launch, key bindings, workflows) is shipped; only screenshots are still missing. The remaining Performance entry is reduced to its still-open sub-items (profiling, pre-warming, lazy pulls). Other portal protocol questions remain open product decisions.
1 parent 651c10b commit e4aa95d

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

docs/developer/SDK-ROADMAP.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,9 @@ All 16 scanner/linter actions refactored to call `argus scan` internally. Action
204204
**Future (post-release):**
205205
- [ ] Additional reporters: `github.py`, `gitlab.py`, `junit.py`, plugin registration system
206206
- [ ] Additional scanners: `codeql.py`, `dependency_review.py` (GitHub-specific)
207-
- [ ] Performance: profiling, pull_policy evaluation, pre-warming, lazy pulls, progress indicators
207+
- [x] ~~Progress indicators~~`argus/cli.py::Spinner` ships phase-aware progress with `--no-spinner` opt-out (PR #2c46fce: `feat(cli): phase-aware scan progress and clearer verbosity flags`)
208+
- [x] ~~`pull_policy` evaluation~~`ArgusConfig.execution.pull_policy` accepts `always | if-not-present | never`; engine + container_runtime honor it
209+
- [ ] Performance: profiling, pre-warming, lazy pulls (the remaining items from the original bundle)
208210

209211
---
210212

@@ -284,15 +286,16 @@ The `argus-portal` web app at `/Users/collinpesicka/Documents/HRL/github.com/arg
284286
- [ ] **Does the portal consume `argus-results.json` natively?** If yes, the TUI's role is "local-dev triage before pushing to portal." If no, we'd want a shared schema/loader library to avoid format drift between CLI and web.
285287
- [ ] **"Send to portal" keybinding**`P` from the TUI uploads the current results (or currently filtered subset) to a configured portal instance. Needs portal API (or upload endpoint) defined first.
286288
- [ ] **"Open in portal"** — deep-link to a scan view: `argus-portal://scan/<id>` or HTTP URL. Works if scans have portal-assigned IDs.
287-
- [ ] **Shared findings renderer**if the portal wants identical per-finding layout to the TUI detail pane, factor the detail rendering into a shared module (core of a future `argus.findings_view` package — portal consumes via API/SDK, TUI consumes via import).
289+
- [x] ~~**Shared findings renderer**~~`argus/core/findings_view.py` is the shared module: TUI imports it from `argus/viewers/terminal/app.py` and the browser interface imports it from `argus/viewers/browser/app.py` + `log_view.py`. Portal can consume the same module if/when it wants identical per-finding layout. (Note: bullets above this — portal protocol questions — remain open product decisions.)
288290

289291
Not all of these belong to the TUI itself — the portal integration items are primarily portal-side concerns. Tracked here so the CLI/TUI side doesn't drift from whatever the portal lands on.
290292

291293
#### Existing polish items (pre-roadtest)
292294

293295
- [ ] Multi-select for batch actions (export a subset, copy CVE list to clipboard)
294296
- [x] `argus scan --interface=terminal` convenience flag — auto-launches the terminal viewer after the scan finishes
295-
- [ ] Screenshot + quickstart in `docs/view-terminal.md`
297+
- [x] ~~Quickstart in `docs/view-terminal.md`~~ — install + launch + key bindings + workflows shipped
298+
- [ ] Screenshot pass for `docs/view-terminal.md` — doc has no images yet
296299

297300
---
298301

0 commit comments

Comments
 (0)