wrkflw

mirror of https://github.com/bahdotsh/wrkflw.git synced 2026-09-02 04:02:34 +02:00

Files

bahdotsh af5e80e97e docs: update crate READMEs for latest features and trim secrets

The crate READMEs were quietly falling behind the actual code. The
executor README didn't mention --job, environment file read-back,
or job-level container directives. The UI README didn't mention job
selection mode or the tui feature flag. The evaluator README didn't
mention composite action input cross-checking.

Meanwhile, the secrets README was 387 lines of documentation for a
crate whose siblings average 25. It had full provider configuration
examples, rate limiting docs, input validation specs, and
benchmarking instructions — all of which belong in rustdoc, not a
README that's supposed to give you a quick overview.

Trim secrets to ~80 lines. Update executor, ui, evaluator, and
wrkflw READMEs to reflect features from PRs #77-#83.

2026-04-02 23:57:40 +05:30

src

feat(ui): add job selection mode to TUI for running individual jobs (#80 )

2026-04-02 15:38:58 +05:30

Cargo.toml

feat(ui): add job selection mode to TUI for running individual jobs (#80 )

2026-04-02 15:38:58 +05:30

README.md

docs: update crate READMEs for latest features and trim secrets

2026-04-02 23:57:40 +05:30

README.md

wrkflw-ui

Terminal user interface for browsing workflows, running them, and viewing logs.

Tabs: Workflows, Execution, Logs, Help
Job selection mode: pick and run individual jobs within a workflow
Hotkeys: 1-4, Tab, Enter, r, R, t, v, e, q, etc.
Optional: enabled via the tui cargo feature flag
Integrates with wrkflw-executor and wrkflw-logging

Example

use std::path::PathBuf;
use wrkflw_executor::RuntimeType;
use wrkflw_ui::run_wrkflw_tui;

# tokio_test::block_on(async {
let path = PathBuf::from(".github/workflows");
run_wrkflw_tui(Some(&path), RuntimeType::Docker, true, false).await?;
# Ok::<_, Box<dyn std::error::Error>>(())
# })?;

Most users should run the wrkflw binary and select TUI mode: wrkflw tui.