diff options
| author | user <user@clank> | 2026-08-18 21:26:00 +0200 |
|---|---|---|
| committer | user <user@clank> | 2026-08-18 21:26:00 +0200 |
| commit | b9e53cace4eb75263077df8623b011e66f5f2241 (patch) | |
| tree | 78e4dfb23f5d1881dc7bfe9e4c96fd543bdfab0b /docs | |
| parent | sl0ppty: aim the top handle at the middle, and stop ruling through the row (diff) | |
| download | slosh-b9e53cace4eb75263077df8623b011e66f5f2241.tar.gz slosh-b9e53cace4eb75263077df8623b011e66f5f2241.tar.xz slosh-b9e53cace4eb75263077df8623b011e66f5f2241.zip | |
slosh: rename the project from sl0ppty
sl0p + pty was error-prone to type and the zero made it worse; slosh
(slop + sh) is one syllable, impossible to typo, and slosh.foo is ours.
Mechanical rename everywhere it appears: binary, env vars (SLOSH,
SLOSH_SESSION, SLOSH_BIN, SLOSH_CONFIG), socket dir (/tmp/slosh-<uid>,
$XDG_RUNTIME_DIR/slosh), config path (~/.config/slosh), header guards,
src/sl0ppty.h -> src/slosh.h, contrib/sl0ppty-dev -> contrib/slosh-dev,
the driving-slosh skill, docs and tests. The sl0ppi fork references and
the sl0p theme stay: one is history, the other is the brand.
The rename surfaced a latent bug in test_osc5577: the hello-reply
answer always appeared on screen twice (ECHOCTL echo plus cat -v), but
a seven-character implementation name happened to wrap the second copy
across the 60-column boundary, so counting substrings in wrapped text
found one and passed for the wrong reason. A five-character name moved
the wrap and exposed it. The loop guard itself is correct -- with echo
off before the request there is exactly one reply -- so the test now
counts on de-wrapped text and tolerates the pane's own echo.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config.md | 20 | ||||
| -rw-r--r-- | docs/design.md | 2 | ||||
| -rw-r--r-- | docs/index.md | 8 | ||||
| -rw-r--r-- | docs/keys.md | 2 | ||||
| -rw-r--r-- | docs/layouts.md | 36 | ||||
| -rw-r--r-- | docs/panes.md | 2 | ||||
| -rw-r--r-- | docs/scripting.md | 22 | ||||
| -rw-r--r-- | docs/shaders.md | 6 | ||||
| -rw-r--r-- | docs/workspaces.md | 22 |
9 files changed, 60 insertions, 60 deletions
diff --git a/docs/config.md b/docs/config.md index db9da89..c9578ac 100644 --- a/docs/config.md +++ b/docs/config.md @@ -3,8 +3,8 @@ One file, in [KDL](https://kdl.dev): ``` -$SL0PPTY_CONFIG, else $XDG_CONFIG_HOME/sl0ppty/config.kdl, else -~/.config/sl0ppty/config.kdl +$SLOSH_CONFIG, else $XDG_CONFIG_HOME/slosh/config.kdl, else +~/.config/slosh/config.kdl ``` `C-a e` opens it in a pane, writing a starting file first if you have none. @@ -22,11 +22,11 @@ plugin that replaced one already loaded needs a new session. ## Two files worth knowing -- **`sl0ppty --dump-config`** writes every setting with its *default* value — +- **`slosh --dump-config`** writes every setting with its *default* value — not the value your config gives it. It is generated from the code, so it cannot drift, and it is a supported way to start a config: - `sl0ppty --dump-config > ~/.config/sl0ppty/config.kdl`. To see what your own - file does, `sl0ppty --check` reads it and reports what it understood. + `slosh --dump-config > ~/.config/slosh/config.kdl`. To see what your own + file does, `slosh --check` reads it and reports what it understood. - **`config/config.kdl`** in the source tree is the same list with the *reasoning* attached — what each setting is for, what it cost to get right, and which ones are opinions. When @@ -35,21 +35,21 @@ plugin that replaced one already loaded needs a new session. ## Checking one ```bash -$ sl0ppty --check # the config a session would read -$ sl0ppty --check themes/mine.kdl # or one you have not installed yet +$ slosh --check # the config a session would read +$ slosh --check themes/mine.kdl # or one you have not installed yet ``` Every problem it found, one per line, with the file and line it happened at — including a setting it does not know: ``` - cannot open /home/you/.config/sl0ppty/themes/nope.kdl + cannot open /home/you/.config/slosh/themes/nope.kdl config.kdl:2: bad prefix: ctrl+nope config.kdl:3: bad key: wobble config.kdl:5: padding takes 1, 2 or 4 values (all, vertical horizontal, or top right bottom left), not 3 config.kdl:6: unknown setting: wobble themes/mine.kdl:7: unknown shader: bloom -~/.config/sl0ppty/config.kdl: 6 problems +~/.config/slosh/config.kdl: 6 problems ``` The problems go to stderr and the summary with them. It exits 1 when it has @@ -99,7 +99,7 @@ Six ready-made themes are in own two lines on top: ```kdl -include "~/.config/sl0ppty/themes/phosphor.kdl" +include "~/.config/slosh/themes/phosphor.kdl" theme { frame_focus "#00ff88" } // ...but that one colour is mine ``` diff --git a/docs/design.md b/docs/design.md index 7da7d60..ce749d2 100644 --- a/docs/design.md +++ b/docs/design.md @@ -23,7 +23,7 @@ special case of anything. ## It runs headless -`sl0ppty --script` is the whole thing without a terminal: commands in, the +`slosh --script` is the whole thing without a terminal: commands in, the composited screen out as JSON. The interactive client and the test suite drive the same object through the same commands, so there is exactly one implementation of what a key does. diff --git a/docs/index.md b/docs/index.md index ebe873d..4997d09 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# sl0ppty +# slosh A terminal multiplexer — panes, tabs, sessions you can detach from — written in C on top of [libghostty-vt](https://github.com/ghostty-org/ghostty). @@ -33,9 +33,9 @@ make test # optional: the whole suite, about thirteen seconds ## Run ```bash -sl0ppty # attach to session "main", creating it if needed -sl0ppty -s work # a named session -sl0ppty ls # what is running +slosh # attach to session "main", creating it if needed +slosh -s work # a named session +slosh ls # what is running ``` Sessions keep running when you detach, or when your terminal or ssh connection diff --git a/docs/keys.md b/docs/keys.md index a8328b7..fb58532 100644 --- a/docs/keys.md +++ b/docs/keys.md @@ -88,7 +88,7 @@ carry their own shift: `"?"` is `"shift+slash"`, `"H"` is `"shift+h"`, `"|"` is encodings, because whether your terminal reports `?` with a shift modifier or as a bare byte is up to your terminal and not to what you meant. -`sl0ppty --check` reads a config and says what it could not honour, one problem +`slosh --check` reads a config and says what it could not honour, one problem per line with a file and a line number. Worth running after editing bindings by hand. diff --git a/docs/layouts.md b/docs/layouts.md index 31ee30c..64d0c1f 100644 --- a/docs/layouts.md +++ b/docs/layouts.md @@ -16,7 +16,7 @@ layout { ``` ```bash -sl0ppty --layout project.layout.kdl +slosh --layout project.layout.kdl ``` ## What to call them @@ -28,7 +28,7 @@ Calling it something else would trade one wrong signal for another: it *is* KDL, and an editor that highlights KDL is worth keeping. A filename cannot enforce anything, so **the document decides which schema it is -held to, not the flag that read it**. `sl0ppty --check` reads what is in front of +held to, not the flag that read it**. `slosh --check` reads what is in front of it: a file with `layout` or `tab` at the top of it is checked as a layout, and a config handed to the same flag is still checked as a config. A file too broken to parse at all is judged by its name, because by then there is nothing else left to @@ -38,7 +38,7 @@ layout, not a config` — replied to a question about a file with the name of another flag. ``` -$ sl0ppty --check project.layout.kdl +$ slosh --check project.layout.kdl project.layout.kdl: ok, a layout ``` @@ -49,7 +49,7 @@ summary, and exits 1 — the shape [checking a config](config.md#checking-one) already has, so one editor compile step and one pre-commit hook read both: ``` -$ sl0ppty --check broken.layout.kdl +$ slosh --check broken.layout.kdl broken.layout.kdl:2: unknown pane property: cmd broken.layout.kdl:3: split is cols or rows, not `diagonal` broken.layout.kdl:4: weight is a number of 150 or more, not `40` @@ -69,8 +69,8 @@ end rather than first so it reads as the summary it is. Loading is the other half of the same answer: ``` -$ sl0ppty --layout ~/.config/sl0ppty/config.kdl -sl0ppty: config.kdl: this is a config, not a layout: `gap` is a setting +$ slosh --layout ~/.config/slosh/config.kdl +slosh: config.kdl: this is a config, not a layout: `gap` is a setting ``` A config handed to `--layout` is named for what it is instead of refused for @@ -105,7 +105,7 @@ That is what lets a layout be checked in beside the project it describes and mea the same thing in everybody's clone: ```kdl -// ~/dev/api/sl0ppty.layout.kdl — no absolute path in it anywhere +// ~/dev/api/slosh.layout.kdl — no absolute path in it anywhere layout { tab name="api" cwd="." { pane command="nvim" @@ -133,14 +133,14 @@ A full annotated example is ## Writing one back out ```bash -sl0ppty -s work cmd '{"cmd":"dump-layout"}' > project.layout.kdl +slosh -s work cmd '{"cmd":"dump-layout"}' > project.layout.kdl ``` writes the session as a layout file: tabs, splits, proportions, directories, commands, which pane you were in. So a session can be checked in, or put back after a restart. -`contrib/sl0ppty-dev` -is that loop, for when the thing you are rebuilding is sl0ppty itself. +`contrib/slosh-dev` +is that loop, for when the thing you are rebuilding is slosh itself. **A pane is dumped with the command it is running**, whether a layout gave it one or you typed it. `label` — what a layout said — comes first and outlives the @@ -170,8 +170,8 @@ restoring gives you a fresh one. Three arguments shape what comes out: ```bash -sl0ppty -s work cmd '{"cmd":"dump-layout","tab":3}' -sl0ppty -s work cmd '{"cmd":"dump-layout","relative_to":"~/dev/api","suspend":"commands"}' +slosh -s work cmd '{"cmd":"dump-layout","tab":3}' +slosh -s work cmd '{"cmd":"dump-layout","relative_to":"~/dev/api","suspend":"commands"}' ``` | argument | what it says | @@ -210,8 +210,8 @@ tab and wherever the file happened to begin in the other five. ## Applying one to a running session ```bash -sl0ppty -s work cmd '{"cmd":"apply-layout","path":"project.layout.kdl"}' -sl0ppty -s work cmd '{"cmd":"apply-layout","kdl":"layout { tab { pane } }","replace":true}' +slosh -s work cmd '{"cmd":"apply-layout","path":"project.layout.kdl"}' +slosh -s work cmd '{"cmd":"apply-layout","kdl":"layout { tab { pane } }","replace":true}' ``` Without `replace`, the tabs the file describes are added to what is already @@ -220,9 +220,9 @@ there. ## Moving a pane between tabs ```bash -sl0ppty cmd '{"cmd":"move-pane","id":3,"tab":2}' # beside that tab's focus -sl0ppty cmd '{"cmd":"move-pane","id":3,"tab":2,"dir":"rows"}' # under it instead -sl0ppty cmd '{"cmd":"move-pane","id":3,"tab":0,"name":"logs"}' # into a tab of its own +slosh cmd '{"cmd":"move-pane","id":3,"tab":2}' # beside that tab's focus +slosh cmd '{"cmd":"move-pane","id":3,"tab":2,"dir":"rows"}' # under it instead +slosh cmd '{"cmd":"move-pane","id":3,"tab":0,"name":"logs"}' # into a tab of its own ``` The pane keeps running: same pty, same scrollback, same process — a move is tree @@ -266,7 +266,7 @@ The [finder](panes.md#finding-a-pane) matches on purposes as well as titles, and ## When the layout is found rather than named Everything above assumes you name the file. When it lives *in* the project — -`sl0ppty.layout.kdl` beside the `.git` — you do not have to: `C-a w` lists the +`slosh.layout.kdl` beside the `.git` — you do not have to: `C-a w` lists the projects under the roots you configured and opening one applies the layout it found there, or a default layout bound to that directory when the project has none, and `C-a W` writes this tab back out as that file. Same syntax, same diff --git a/docs/panes.md b/docs/panes.md index dd1c435..e400479 100644 --- a/docs/panes.md +++ b/docs/panes.md @@ -62,7 +62,7 @@ nothing you click can disagree with what is on screen. name while there is one, so a program that keeps announcing something stale — an agent still spinning the summary of a task it finished — is overruled by naming its pane, from the gesture below or from a script: - `sl0ppty cmd '{"cmd":"set-name","target":"pane","id":3,"name":"agent: gbos"}'`. + `slosh cmd '{"cmd":"set-name","target":"pane","id":3,"name":"agent: gbos"}'`. An empty name hands the label back. - **Double-click a name to rename it in place** — a pane's title or a tab in the strip. Enter keeps it, Escape abandons it, empty gives it back to the program. diff --git a/docs/scripting.md b/docs/scripting.md index 8268c31..43615a2 100644 --- a/docs/scripting.md +++ b/docs/scripting.md @@ -1,6 +1,6 @@ # Scripting -Three things make sl0ppty easy to drive from other programs: a socket that does +Three things make slosh easy to drive from other programs: a socket that does everything the keyboard does, an escape sequence a pane can use to draw its own chrome, and a headless mode that is the whole program without a terminal. @@ -10,9 +10,9 @@ One JSON object per line, over the session's socket. A detached session answers exactly as an attached one does. ```bash -$ sl0ppty -s work cmd '{"cmd":"new-tab","name":"api"}' +$ slosh -s work cmd '{"cmd":"new-tab","name":"api"}' {"ok":true,"id":2} -$ sl0ppty -s work cmd '{"cmd":"panes"}' +$ slosh -s work cmd '{"cmd":"panes"}' {"ok":true,"panes":[{"id":1,"title":"nvim","alive":true,...}]} ``` @@ -54,9 +54,9 @@ Everything a program needs in a project it has never seen — open it, ask what in it, act on the purposes the project's own layout declared: ```bash -$ sl0ppty -s work cmd '{"cmd":"open-workspace","name":"api"}' +$ slosh -s work cmd '{"cmd":"open-workspace","name":"api"}' {"ok":true,"tab":3,"purpose":"project:api.5c1f0a3b","path":"/home/you/dev/api","created":true,"tabs":1,"honoured":0} -$ sl0ppty -s work cmd '{"cmd":"open-workspace","name":"api"}' +$ slosh -s work cmd '{"cmd":"open-workspace","name":"api"}' {"ok":true,"tab":3,"purpose":"project:api.5c1f0a3b","path":"/home/you/dev/api","created":false,"tabs":0,"honoured":0} ``` @@ -68,11 +68,11 @@ re-attach. Then read the tab it handed back: ```bash -$ sl0ppty -s work cmd '{"cmd":"panes"}' \ +$ slosh -s work cmd '{"cmd":"panes"}' \ | jq -c '.panes[] | select(.tab_id == 3) | {id, purpose, suspended}' {"id":7,"purpose":"agent:main","suspended":false} {"id":8,"purpose":"service:web","suspended":true} -$ sl0ppty -s work cmd '{"cmd":"rerun","id":8}' # start the dev server +$ slosh -s work cmd '{"cmd":"rerun","id":8}' # start the dev server ``` The project's own layout file decided that `service:web` is the dev server and @@ -124,9 +124,9 @@ otherwise be answered into a loop, which is exactly what `hello` used to do: ## Driving it from an agent Everything above is what an agent needs, and none of it says which parts matter. -`.agents/skills/driving-sl0ppty/SKILL.md` is the same socket written as +`.agents/skills/driving-slosh/SKILL.md` is the same socket written as instructions: how a program in a pane finds out which session it is in -(`SL0PPTY_SESSION`, `SL0PPTY_BIN`), why work belongs in a pane that *was given a +(`SLOSH_SESSION`, `SLOSH_BIN`), why work belongs in a pane that *was given a command* rather than typed into somebody's shell, that `alive` and `exit_code` are how you wait rather than reading the screen for a marker your own echo matches, and that `purpose` is the handle to find things by because titles change underneath @@ -141,14 +141,14 @@ reading it first. ## Headless -`sl0ppty --script` is the whole program without a terminal: commands on stdin, +`slosh --script` is the whole program without a terminal: commands on stdin, answers on stdout. It is how the test suite works — drive these events, assert this screen — which is also why the suite is 1,500-odd real end-to-end checks that finish in about thirteen seconds. ```bash $ printf '%s\n' '{"cmd":"split","dir":"cols"}' '{"cmd":"snapshot","format":"text"}' \ - | sl0ppty --script --cols 80 --rows 24 -- /bin/sh + | slosh --script --cols 80 --rows 24 -- /bin/sh ``` The bare-verb form (`snapshot text`, `send \x01\\`, `resize 100 30`) is a diff --git a/docs/shaders.md b/docs/shaders.md index d1eba23..860ad24 100644 --- a/docs/shaders.md +++ b/docs/shaders.md @@ -126,7 +126,7 @@ not always in a state to put it back: |---|---| | `printf '\033]5577;1;shader;\033\\'` | from the program, one exchange, both rects | | `printf '\033]5577;1;shader-load;/path/to/preset.kdl\033\\'` | a `shaders { }` file, read by the session and routed by `where=` | -| `sl0ppty cmd '{"cmd":"clear-shaders","id":3}'` | from outside; `id` 0 or absent means the focused pane | +| `slosh cmd '{"cmd":"clear-shaders","id":3}'` | from outside; `id` 0 or absent means the focused pane | | the `clear-shaders` action | on a key you bind, or from the palette | None of them is gated on `in_band_shaders`. A chain can outlive the setting that @@ -162,7 +162,7 @@ a config file would be a second opinion about what it says, exactly where commen meet quoted strings. It is a readline prompt, so editing, up/down and ctrl-r work as they do in a shell, -and history is kept between runs in `$XDG_DATA_HOME/sl0ppty/shader-repl.history` -- +and history is kept between runs in `$XDG_DATA_HOME/slosh/shader-repl.history` -- the chains only, since `:quit` is not something you want to press up past. Tab completes the commands, the shader names, the property keys, the expression language's own variables, constants and functions, and filenames after `:load`. @@ -179,7 +179,7 @@ said about anybody else. ## Your own, compiled A shader is a C function from one cell to that cell's colours. Any `*.so` in -`~/.config/sl0ppty/shaders/` that exports one is loaded at startup and named in +`~/.config/slosh/shaders/` that exports one is loaded at startup and named in the config exactly like a built-in. Skeleton, Makefile and the rules a shader has to keep: `contrib/shader-plugin`. diff --git a/docs/workspaces.md b/docs/workspaces.md index 5e00b19..4963683 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -17,7 +17,7 @@ A subdirectory of a configured root with one of two markers in it: | marker | what it is | |---|---| -| `sl0ppty.layout.kdl` | a *declared* project — it says what it needs open | +| `slosh.layout.kdl` | a *declared* project — it says what it needs open | | `.git` | an *inferred* one — you work here, but you have not said how | Anything else is not a project, and nothing is guessed from what is inside it. @@ -40,7 +40,7 @@ Two settings, both in your [config](config.md): ```kdl project_roots "~/dev" "~/work" depth=2 -project_layout "~/.config/sl0ppty/project.layout.kdl" +project_layout "~/.config/slosh/project.layout.kdl" ``` `project_roots` takes more than one directory because people have more than one — @@ -59,7 +59,7 @@ paths in it bind to the project being opened, not to the directory the file live in** — deliberately the opposite of the rule for a layout you name yourself, where a relative `cwd=` is relative to that file ([layouts](layouts.md#the-shape)). The whole point of one shared layout is that `cwd="."` means *this* project; bound to -itself it would open every project in `~/.config/sl0ppty`. Unset, a project opens +itself it would open every project in `~/.config/slosh`. Unset, a project opens as one pane running your shell in it. **Nothing sniffs `package.json` or `Cargo.toml` to guess what to run.** A table @@ -94,7 +94,7 @@ C-a w picker: ~/work newthing .git · no layout Enter your project_layout, cwd bound to newthing C-a Enter, npm run dev arrange it, run things C-a P service:web Enter tag the pane that matters -C-a W "wrote sl0ppty.layout.kdl · 4 panes, 2 suspended" +C-a W "wrote slosh.layout.kdl · 4 panes, 2 suspended" ``` Tomorrow, `C-a w Enter` rebuilds that tab with the dev server in the pane you put @@ -109,9 +109,9 @@ every tab carrying that purpose and says how many. ## Saving one -`C-a W` writes the focused tab to `sl0ppty.layout.kdl` in the project's directory, +`C-a W` writes the focused tab to `slosh.layout.kdl` in the project's directory, and the toast says what happened: -`wrote sl0ppty.layout.kdl · 4 panes, 2 suspended`. +`wrote slosh.layout.kdl · 4 panes, 2 suspended`. **What each pane is running goes in with it.** That is what makes writing a layout the same act as arranging one: split the tab, start the dev server, start the log @@ -155,7 +155,7 @@ the screen — so it says so in the request. how a hand-arranged tab becomes a project's layout without opening it through the picker first. -`sl0ppty --check sl0ppty.layout.kdl` holds the result to the layout schema and +`slosh --check slosh.layout.kdl` holds the result to the layout schema and prints one `file:line: what` per problem, so a project's layout goes through the same check as everything else you commit — see [layouts](layouts.md#what-to-call-them). @@ -202,9 +202,9 @@ Open one and act on what is in it, over the [control socket](scripting.md#the-control-socket): ```bash -$ sl0ppty -s work cmd '{"cmd":"open-workspace","name":"api"}' +$ slosh -s work cmd '{"cmd":"open-workspace","name":"api"}' {"ok":true,"tab":3,"purpose":"project:api.9f3c1d20","created":true,...} -$ sl0ppty -s work cmd '{"cmd":"panes"}' # keep the ones whose tab_id is 3 +$ slosh -s work cmd '{"cmd":"panes"}' # keep the ones whose tab_id is 3 ``` | verb | takes | answers | @@ -214,8 +214,8 @@ $ sl0ppty -s work cmd '{"cmd":"panes"}' # keep the ones whose tab_id is 3 | `close-workspace` | `name` or `purpose` | `closed` — how many tabs went | | `save-workspace` | `tab` (0 for the current one), `path` for a tab that is not a workspace yet, `suspend`, `force` | `path` `purpose` `panes` `suspended` `replaced` | -Every one of them is in the bare dispatcher too, so `sl0ppty -s work cmd -workspaces` and `sl0ppty -s work cmd open-workspace api` do the same from a shell +Every one of them is in the bare dispatcher too, so `slosh -s work cmd +workspaces` and `slosh -s work cmd open-workspace api` do the same from a shell without quoting JSON ([scripting](scripting.md#the-control-socket)). `open-workspace` is idempotent, which is the property that makes it safe to call |
