Skip to content

Commit 6af3f74

Browse files
committed
feat(launcher): add 'just run'/'just launch' + rewrite QUICKSTART-USER
The user-facing launcher was missing: the Justfile had no run/setup/install recipe, and QUICKSTART-USER.adoc was an unfilled RSR template promising 'just run', 'just setup', 'just uninstall', 'just stapeln-run' — none of which existed. - Add 'just run *ARGS' (alias 'just launch'): builds and starts the interactive vsh shell, passing extra args through to the binary. Verified end-to-end: 'just run --version' -> vsh 0.9.0 (exit 0); the REPL banner starts; and 'just run <script>' executes and exits 0. - Rewrite QUICKSTART-USER.adoc to the real, working flow. Every 'just' command it cites is a real recipe (verified via 'just --show'): run/launch, build-cli, install-cli, test-cli, container-build/run/shell, doctor, heal, tour, help-me, clean. Uninstall documents the honest 'cargo uninstall vsh' path. Removes the template placeholder/instruction cruft. - Point the wiki For-Users page at 'just run' as the primary launch path. Note: full alignment to the external launcher standard (hyperpolymath/standards) is not attempted here — that repo is outside this session's scope. This adds a real, verified launch entry point consistent with what the quickstart promised. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KfgJznd6jzSeDYsSXGAXkU
1 parent 6924532 commit 6af3f74

4 files changed

Lines changed: 97 additions & 70 deletions

File tree

CHANGELOG.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1717
- Full POSIX shell compliance (subset)
1818
- RMO (Remove-Match-Obliterate) proofs for GDPR compliance
1919

20+
=== Added — 2026-07-16
21+
22+
==== Launcher
23+
- `just run` (alias `just launch`) — the user-facing launcher for the `vsh`
24+
shell, previously missing. Builds and starts the interactive REPL; passes
25+
extra arguments through to the binary (`just run --version`,
26+
`just run script.vsh`). Verified end-to-end: `--version` prints `vsh 0.9.0`
27+
(exit 0), the REPL banner starts interactively, and script execution runs and
28+
exits 0.
29+
- `QUICKSTART-USER.adoc` rewritten from the unfilled RSR template to the real,
30+
working flow — it no longer references non-existent recipes (`just setup`,
31+
`just uninstall`, `just stapeln-run`, `just install --portable`); every `just`
32+
command it now cites is a real recipe (verified via `just --show`). Uninstall
33+
documents the honest `cargo uninstall vsh` path.
34+
2035
=== Verified — 2026-07-16
2136

2237
==== Proofs

Justfile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
# Default recipe - show available commands
55
import? "contractile.just"
66

7+
# `just launch` is a synonym for `just run` (launch the vsh shell)
8+
alias launch := run
9+
710
default:
811
@just --list
912

@@ -123,6 +126,14 @@ test-cli:
123126
cd impl/rust-cli && cargo test
124127
@echo "✓ Rust CLI tests passed"
125128

129+
# Launch the interactive vsh shell (the primary deliverable). Extra args pass
130+
# through to the binary:
131+
# just run # start the interactive REPL
132+
# just run --version # print version and exit
133+
# just run script.vsh # run a script
134+
run *ARGS:
135+
cd impl/rust-cli && cargo run -- {{ARGS}}
136+
126137
# Build all FFI layers
127138
build-ffi: build-ffi-zig build-ffi-ocaml
128139
@echo "✓ All FFI layers built"

QUICKSTART-USER.adoc

Lines changed: 62 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,125 +1,123 @@
11
// SPDX-License-Identifier: CC-BY-SA-4.0
22
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
3-
// Template: QUICKSTART-USER.adoc — 5-minute path to working software
4-
// Replace valence-shell, Valence Shell — See README.adoc for details., just run, Valence Shell started successfully. with actuals
53
= valence-shell — Quick Start for Users
64
:toc:
75
:toclevels: 2
86

97
== What is valence-shell?
108

11-
Valence Shell — See README.adoc for details.
9+
Valence Shell (`vsh`) is a formally verified, reversible Unix-style shell: its
10+
core filesystem operations are backed by machine-checked proofs, and it provides
11+
a proven undo/redo layer, named checkpoints, and proof-annotated dry runs. See
12+
link:README.adoc[README.adoc] for the full overview.
1213

13-
== Prerequisites
14-
15-
Before you begin, ensure you have:
16-
17-
* **just** — task runner (https://github.com/casey/just[install guide])
18-
* Platform-specific requirements listed below
19-
20-
[cols="1,3"]
21-
|===
22-
| Platform | Additional Requirements
14+
[IMPORTANT]
15+
====
16+
v0.9.0 is an **advanced research prototype — NOT production-ready**. Great for
17+
learning and experimentation; do not use it as your login shell or trust it with
18+
irreplaceable data.
19+
====
2320

24-
| Linux
25-
| See README.adoc
26-
27-
| macOS
28-
| See README.adoc
21+
== Prerequisites
2922

30-
| Windows
31-
| See README.adoc
32-
|===
23+
* **Rust toolchain 1.88+** — to build and run the `vsh` CLI
24+
(https://rustup.rs[install via rustup]).
25+
* **just** — task runner (https://github.com/casey/just[install guide]).
3326

34-
== Install
27+
The six proof systems (Coq, Lean 4, Agda, Isabelle, Mizar, Z3) are **optional** —
28+
they are only needed to re-check the formal proofs, not to build or run the shell.
3529

36-
=== Option 1: Standard Install (recommended)
30+
== Launch it (fastest path)
3731

3832
[source,bash]
3933
----
40-
# Clone and set up
4134
git clone https://github.com/hyperpolymath/valence-shell.git
4235
cd valence-shell
43-
just setup
44-
----
45-
46-
The setup script will:
4736
48-
* Detect your platform and shell
49-
* Install missing dependencies (with your permission)
50-
* Configure the application
51-
* Offer install location choices
52-
* Run a self-diagnostic to verify everything works
37+
just run # build (debug) and start the interactive shell
38+
# or, equivalently:
39+
just launch
40+
----
5341

54-
=== Option 2: Container (via Stapeln)
42+
`just run` passes any extra arguments through to the binary:
5543

5644
[source,bash]
5745
----
58-
just stapeln-run
46+
just run --version # print version and exit
47+
just run path/to/script # execute a script non-interactively
5948
----
6049

61-
=== Option 3: Portable (no system changes)
50+
Expected first-run output is the `vsh` banner followed by an interactive prompt.
51+
Type `help` for commands, `undo` to reverse the last operation, and `exit` to
52+
leave.
53+
54+
== Build / install
6255

6356
[source,bash]
6457
----
65-
just install --portable --prefix=./valence-shell-portable
58+
just build-cli # release build -> impl/rust-cli/target/release/vsh
59+
just install-cli # cargo install to ~/.cargo/bin (then just run `vsh`)
60+
just test-cli # run the CLI test suite
6661
----
6762

68-
== First Run
63+
After `just install-cli`, the `vsh` binary is on your `PATH`:
6964

7065
[source,bash]
7166
----
72-
just run
67+
vsh --version
68+
vsh # start the shell
7369
----
7470

75-
Expected output:
71+
You can also drive Cargo directly if you prefer:
7672

77-
[source]
73+
[source,bash]
7874
----
79-
Valence Shell started successfully.
75+
cd impl/rust-cli
76+
cargo run # start the interactive shell
77+
cargo build --release # build the release binary
78+
./target/release/vsh --version
8079
----
8180

82-
== Self-Diagnostic
83-
84-
If something isn't working:
81+
== Run in a container
8582

8683
[source,bash]
8784
----
88-
just doctor
85+
just container-build # build the container image (uses Containerfile)
86+
just container-run # run verification in the container
87+
just container-shell # interactive shell inside the container
8988
----
9089

91-
This checks all dependencies, permissions, paths, and connectivity.
92-
If it finds issues, it will suggest fixes.
93-
94-
To attempt automatic repair:
90+
== Self-diagnostic
9591

9692
[source,bash]
9793
----
98-
just heal
94+
just doctor # check required tools, hardcoded paths, environment
95+
just heal # attempt automatic repair (permissions, stale caches)
9996
----
10097

101-
== Get Help
98+
== Get help
10299

103-
* **In-app**: `just run --help`
104100
* **Guided tour**: `just tour`
105-
* **Report a problem**: `just help-me` (pre-fills diagnostic context)
101+
* **Report a problem** (pre-fills platform diagnostics): `just help-me`
102+
* **All recipes**: `just --list`
103+
* **In-shell help**: type `help` at the `vsh` prompt, or `vsh --help`
106104
* **Wiki**: https://github.com/hyperpolymath/valence-shell/wiki
107105

108106
== Uninstall
109107

108+
If you installed with `just install-cli` (which uses `cargo install`):
109+
110110
[source,bash]
111111
----
112-
just uninstall
112+
cargo uninstall vsh
113113
----
114114

115-
You will be asked:
116-
117-
1. Which uninstall tier (Bennett reversible, parameter-based, standard, or secure)
118-
2. Whether to include or exclude your data
119-
3. Whether to clear caches and LLM models
115+
A source checkout leaves nothing outside the repository directory — delete the
116+
clone to remove it. Build artifacts can be cleared with `just clean`.
120117

121-
== Next Steps
118+
== Next steps
122119

123-
* Read the link:README.adoc[README] for full feature overview
124-
* Read the link:EXPLAINME.adoc[EXPLAINME] for architecture and design decisions
125-
* Try `just tour` for a guided walkthrough
120+
* link:README.adoc[README] — full feature overview and verification status
121+
* link:EXPLAINME.adoc[EXPLAINME] — architecture and the claims-vs-evidence trail
122+
* link:docs/USER_GUIDE.md[User Guide] — detailed usage
123+
* link:FAQ.adoc[FAQ] — common questions

docs/wiki/For-Users.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,21 @@ detailed canonical guides live in the repository and are linked throughout.
1818
## Install & run (the short path)
1919

2020
The interactive shell is the Rust CLI in `impl/rust-cli/`. It needs only a Rust
21-
toolchain (1.88+); the six proof systems are **optional** and only needed if you
22-
want to re-check the proofs yourself.
21+
toolchain (1.88+) and [`just`](https://github.com/casey/just); the six proof
22+
systems are **optional** and only needed if you want to re-check the proofs
23+
yourself.
2324

2425
```bash
2526
git clone https://github.com/hyperpolymath/valence-shell.git
26-
cd valence-shell/impl/rust-cli
27+
cd valence-shell
2728

28-
cargo build --release # builds the `vsh` binary
29-
cargo run # start the interactive shell
30-
./target/release/vsh --version # or run the release binary directly
29+
just run # build and launch the interactive shell (alias: just launch)
30+
just run --version # print version and exit
31+
just install-cli # install `vsh` to ~/.cargo/bin, then just run `vsh`
3132
```
3233

34+
Prefer Cargo directly? `cd impl/rust-cli && cargo run` does the same thing.
35+
3336
Canonical, longer install guide (containers, portable install, self-diagnostics):
3437
[`QUICKSTART-USER.adoc`](https://github.com/hyperpolymath/valence-shell/blob/main/QUICKSTART-USER.adoc).
3538

0 commit comments

Comments
 (0)