Skip to content

Commit 361cd62

Browse files
docs(cli): Allign docs and clean redaction.
1 parent 6a0a7c0 commit 361cd62

3 files changed

Lines changed: 23 additions & 23 deletions

File tree

cli/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,9 +147,9 @@ Bundles your app into a self-contained `dist/` for offline use or self-hosting:
147147

148148
```text
149149
$ edge build
150-
successful - vendored runtime
151-
successful - fetched compiler.wasm
152-
successful - vendored packages
150+
(successful) vendored runtime
151+
(successful) fetched compiler.wasm
152+
(successful) vendored packages
153153
154154
bundled to dist/
155155

cli/src/ui.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,24 +140,24 @@ pub fn spinner(label: &str) -> Spinner {
140140
}
141141

142142
impl Spinner {
143-
/// Stop the spinner and print a `successful - {msg}` line in green.
143+
/// Stop the spinner and print a `(successful) {msg}` line in green.
144144
pub fn done(self, msg: &str) {
145145
// Drop stops the thread and clears the line; the result line goes right after.
146146
drop(self);
147147
if plain() {
148-
eprintln!(" successful - {msg}");
148+
eprintln!(" (successful) {msg}");
149149
} else {
150-
eprintln!(" {} {msg}", "successful -".green());
150+
eprintln!(" {} {msg}", "(successful)".green());
151151
}
152152
}
153153

154-
/// Stop the spinner and print an `unsuccessful - {msg}` line in red.
154+
/// Stop the spinner and print an `(unsuccessful) {msg}` line in red.
155155
pub fn fail(self, msg: &str) {
156156
drop(self);
157157
if plain() {
158-
eprintln!(" unsuccessful - {msg}");
158+
eprintln!(" (unsuccessful) {msg}");
159159
} else {
160-
eprintln!(" {} {msg}", "unsuccessful -".red());
160+
eprintln!(" {} {msg}", "(unsuccessful)".red());
161161
}
162162
}
163163
}

docs/pages/reference/cli.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: "CLI"
2+
title: "Command Line Interface"
33
description: "The Edge Python developer CLI: run, serve, repl, init, package management, and build."
44
---
55

66
The `edge` developer CLI. Write `.py`, run it, serve it, ship it — you never compile anything yourself. `edge` hosts the [Edge Python runtime](/getting-started/what-it-is#where-it-runs) in a headless Chromium provisioned at install time, then runs your code against it. You just point it at a file.
77

88
```bash
9-
edge run app.py # run a script
10-
edge serve # dev server with live reload
11-
edge repl # interactive shell (demo)
12-
edge test # run *_test.py files (not implemented yet)
13-
edge init my-app # scaffold a project
14-
edge add network # add a package to packages.json
15-
edge remove network # remove a package from packages.json
16-
edge build # bundle to dist/
17-
edge uninstall # remove the binary, PATH entry, optionally Chromium
9+
edge run app.py # run a script
10+
edge serve # dev server with live reload
11+
edge repl # interactive shell (demo)
12+
edge test # run *_test.py files (not implemented yet)
13+
edge init my-app # scaffold a project
14+
edge add network # add a package to packages.json
15+
edge remove network # remove a package from packages.json
16+
edge build # bundle to dist/
17+
edge uninstall # remove the binary, PATH entry, optionally Chromium
1818
```
1919

2020
The runtime does the actual work; `edge` is the loop around it. It launches system Chromium headless, serves the runtime alongside your code, runs everything in that browser, and streams output back to your terminal. `edge serve` opens the same setup in your own browser.
@@ -64,7 +64,7 @@ A dev server for browser apps. Serves your project directory and reloads the pag
6464
```text
6565
$ edge serve
6666
http://localhost:5173
67-
watching .
67+
watching.
6868
```
6969

7070
Flags: `--port <n>` (default `5173`), `--open` (open the browser).
@@ -138,9 +138,9 @@ Bundles your app into a self-contained `dist/` for offline use or self-hosting:
138138

139139
```text
140140
$ edge build
141-
successful - vendored runtime
142-
successful - fetched compiler.wasm
143-
successful - vendored packages
141+
(successful) vendored runtime
142+
(successful) fetched compiler.wasm
143+
(successful) vendored packages
144144
145145
bundled to dist/
146146

0 commit comments

Comments
 (0)