Skip to content

Commit d6a1408

Browse files
committed
docs: avoid cargo run in workflows
1 parent 8a98c99 commit d6a1408

4 files changed

Lines changed: 12 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ Download the archive for your OS from GitHub Releases, extract it, and put `rexo
1515
### Option B: Build from source
1616

1717
```bash
18+
# Install to ~/.cargo/bin (recommended for dev)
19+
cargo install --path crates/rexos-cli --locked
20+
rexos --help
21+
22+
# Or build a local binary
1823
cargo build --release -p rexos-cli
1924
./target/release/rexos --help
2025
```

docs/plans/2026-03-01-cargo-workspace-split.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
**Files:**
1616
- Modify: `Cargo.toml` (becomes virtual workspace)
17-
- Modify: `init.sh` (update `cargo run` target)
17+
- Modify: `init.sh` (run the built `rexos` binary for smoke checks)
1818
- Modify: `README.md` (update dev commands)
1919
- Create: `crates/rexos/Cargo.toml`
2020
- Create: `crates/rexos/src/lib.rs`
@@ -51,8 +51,8 @@ Each crate gets a minimal `lib.rs` that either owns code (moved modules) or re-e
5151

5252
**Step 4: Update `init.sh` + README**
5353

54-
- `init.sh` should use `cargo run -p rexos-cli -- --help`.
55-
- README examples should use `cargo run -p rexos-cli -- ...`.
54+
- `init.sh` should run the built binary for the smoke check: `./target/debug/rexos --help`.
55+
- README examples should use `rexos ...` (or `./target/<profile>/rexos ...` if not installed).
5656

5757
---
5858

@@ -103,4 +103,3 @@ Run:
103103
git add -A
104104
git commit -m "refactor: split rexos into cargo workspace"
105105
```
106-

features.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"category": "functional",
1212
"priority": "p0",
1313
"description": "`rexos --help` prints CLI usage.",
14-
"steps": ["Run `cargo run -- --help`", "Verify help text is printed and exit code is 0."],
14+
"steps": ["Run `rexos --help`", "Verify help text is printed and exit code is 0."],
1515
"passes": false,
1616
"notes": ""
1717
},
@@ -20,7 +20,7 @@
2020
"category": "functional",
2121
"priority": "p0",
2222
"description": "`rexos init` creates `~/.rexos/config.toml` and `~/.rexos/rexos.db` if missing.",
23-
"steps": ["Run `cargo run -- init`", "Verify config file exists", "Verify SQLite DB exists"],
23+
"steps": ["Run `rexos init`", "Verify config file exists", "Verify SQLite DB exists"],
2424
"passes": false,
2525
"notes": ""
2626
},
@@ -107,4 +107,3 @@
107107
}
108108
]
109109
}
110-

init.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ echo "[rexos] tests..."
88
cargo test
99

1010
echo "[rexos] smoke: CLI help"
11-
cargo run -p rexos-cli -- --help >/dev/null
11+
cargo build -p rexos-cli
12+
./target/debug/rexos --help >/dev/null
1213

1314
echo "[rexos] done"

0 commit comments

Comments
 (0)