diff options
| author | Gabriel Schneider <[email protected]> | 2026-11-17 01:15:28 -0300 |
|---|---|---|
| committer | Gabriel Schneider <[email protected]> | 2026-11-17 12:15:01 -0300 |
| commit | 2e6777e06e3f3e9d59ec847b98e0cb676d04296a (patch) | |
| tree | de4f2cecfe92706ca7033527d326042f6e90e8a5 /docs/typ/reference.typ | |
| parent | 91360c20923c8ce30829f19bcd192bb78a4c3918 (diff) | |
| download | pardes-2e6777e06e3f3e9d59ec847b98e0cb676d04296a.tar.gz pardes-2e6777e06e3f3e9d59ec847b98e0cb676d04296a.zip | |
main: the command line is commands that describe themselves, over the tree that does
The user: "the cli should be like a living documentation, similar to 9p
and maybe even share the source code but with different sinks", rex's
CLI the model. pardes [flags] [FILE] opens, starts or pages as it did; a
first word naming a command is that command (a file named so is ./ps, or
after --): ps, attach [NAME], kill NAME|--all, new [flags] [FILE] for
sessions; do WORD [ARG] and words [GROUP] for the builtins; fs VERB [PATH]
for the tree; help [CMD|WORD|PATH], completion SHELL, skill, version.
One definition, several sinks. main.zig's `cmds` (an EnumArray over the
Cmd enum: group, args, first-screen line, doc, examples, see-also) is
both what args[1] is matched against and every command's help; `flags`
(over the Flag enum: what it takes, its doc, session/open/old) is both
the flag loop's parser and `help new`. The 70-line help_text and the flag
enum kept apart from it are gone; every flag behaves as before, and
--ps, --attach[=NAME], --kill=NAME, --kill-all, -h/--help and --version
are the commands' old spellings for a release (EDITOR='pardes --wait'
unchanged). What a word or a file does is the tree's to say: words,
help WORD, help PATH, fs and the completions read /commands and /README
over cloud9's Fsys, from the session (-s NAME, else $PARDES_9P, else the
only one whose socket answers) or, with none, from a core this process
makes (Pardes.create, never stepped: no shell, file or socket) and serves
on one end of a socket pair to an Fsys on the other (`Here`: cloud9's
engine, one thread), so both are the same client over the same tree.
With no session, fs ls/stat/help/complete and a read of README, commands
or ctl answer; a read of anything else, or a write, says it is a running
session's and how to start one. do picks the ctl by /commands' scope (a
pane's word needs $PARDES_PANE or -p N) and prints a refusal in the
session's words. completion prints a bash, fish or zsh script that asks
`pardes completion -- WORDS` back. skill prints src/skill.txt, the
recipes and traps, which leaves the inventory to pardes help. version
adds the 9P the tree speaks.
The reference's "The pardes command" includes docs/typ/command-line.txt,
`pardes help --all` (never a session's), which the builtins-json step
(-Dplatform=tui) now writes too; a main.zig test fails when it is stale.
test/process/cli.zig: five cases through the binary, with and without a
session; flags' eight pass unchanged.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_016Y9MNBECMWcJD5pdS4SR6T
Diffstat (limited to 'docs/typ/reference.typ')
| -rw-r--r-- | docs/typ/reference.typ | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ index 7360179f..d359489b 100644 --- a/docs/typ/reference.typ +++ b/docs/typ/reference.typ @@ -1172,6 +1172,19 @@ says the session is gone); with waits there. Bare `pardes` in a pane refuses and names `--nested`, which starts a separate session whose shells do not forward to it. +A first word that names a command is that command instead (a file named +so is `./ps`, or after `--`): `ps`, `attach`, `kill` and `new` for +sessions; `do WORD` and `words` for the builtins of #file("/commands"); +`fs` for the tree, through a 9P client in the binary, a refusal in the +session's own words; `help`, `completion`, `skill` and `version`. A +command that acts on a session takes `-s NAME`, else `$PARDES_9P`, else +the only one running; with none, `help`, `words`, `completion` and a read +of #file("/README"), #file("/commands") or #file("/ctl") ask a core made +in the command's own process. What follows is `pardes help --all`, printed +by the build (docs/typ/command-line.txt), so it is what the binary says. + +#raw(read("command-line.txt"), block: true) + = Placement <placement> A new pane goes in the column whose tag asked, else the active column (last typed or left-clicked in, |
