The utilities

The commands you type. Every one of them is documented here, and the documentation is the source of truth the implementation is held to - utilities/0_conventions.md is the shared contract all of them obey, and a utility that breaks it is a bug in the utility.

Why they look the way they do

A GodspeedOS utility is not a Unix utility with the corners knocked off. The primitives Unix builds on do not exist here: no fork, no exec, no inherited file descriptors, no ambient stdin, no environment inheritance, no signals. What replaces them is capabilities.

   UNIX                              GODSPEEDOS
   ls /data | grep .txt              dir /data | match .txt
   ────────────────────              ──────────────────────
   fork + exec + pipe(2)             the shell carries each stage's output
   fd 1 inherited by the child       on; a SERVICE stage gets an endpoint
   ambient access to /data           `dir` holds a cap to `fs`, or it
                                     cannot read anything at all

Three consequences you will feel immediately:

  • rm -rf / cannot exist. A utility can only touch what it was granted. There is no ambient authority to leak through a fork.
  • Words, not flags. write append /f.txt text, not write -a. A flag is a character to memorise; a word is readable a year later. (0_conventions.md §1.)
  • Every utility answers version and help. Not as a courtesy - as a contract, checked.

The full set

Each links to its full specification: what it is, what it may do, what it may not do, and how it fails.

Files and directories

dirlist a directory
cdchange current location
pwdprint the folder you are in
homego to your home folder
readprint a file's contents
writecreate, overwrite, append, or prepend a file
mkdircreate a directory
copycopy a file or a whole subtree
moverelocate a file
renamerename a file or directory in place
deleteremove a file, directory, or whole subtree
sealfreeze a file's content, permanently (no unseal)
churnhammer the filesystem for N seconds so a power cut lands somewhere
findsearch the tree for a name
treeprint the directory hierarchy
editthe full-screen editor (a bounded piece table - any file size)
fcapopen a file as a real kernel capability
drivesmanage attached disks

Text and records

echowrite text
docsthe manual: what the system is, and what you can rely on
paginateread long output a screenful at a time (pipe stage)
scrollbackread back what has scrolled off the screen (also: PgUp)
matchkeep the lines that match (the grep-equivalent)
counthow many lines, words, and bytes
sortorder the lines
first / lastkeep the first or last N lines
where / select / to / fromtyped record pipelines

The system

statuswhat is running, and where
observethe live full-screen view
capswhat authority a service actually holds
whatiswhat a name is: built-in, script, pipe stage, or service
tracelive kernel state: what is stuck, who can reach whom
eventswhat was recorded: IPC ring, metrics, logs, capture to disk
memmemory
coresthe cores that came up
hardwarethis machine's devices, and what drives each
askplain questions about this machine, answered from what its services know
godspeedthe native package manager: its settings, and the registry reached over verified TLS
downloada file from a web server, saved here: https:// checked, http:// said to be unchecked
spawncapdiagnostic: spawn a service and prove the capability to it routes
uptimehow long since boot
datethe wall clock
audiosound: what is playing, the volume, a test tone
aboutwhat this system is
versionversion, of anything
clearclear the screen

Lifecycle

spawnstart a service
killstop one
restartstop and start, possibly on another core
chaoskill things deliberately, and see what survives
rebootrestart the machine, now or after a delay
poweroffnot provided - and the page says why
shutdownturn the machine off, now or after a delay (hardware-verified on all five boards)
backgroundrun long work as a job, so the prompt stays usable

Networking

netam I on the network?
wifiwhat wireless networks are there, and join one
socka UDP socket as a capability
pingcontinuous ICMP echo
tcpone TCP transaction: connect, send, read, close
serveaccept one TCP connection and echo what arrives

Scripting

runexecute a script of commands
assertverify a result or output (the test verb)
resultthe previous command's result (Ok / Err)
waitwait
repeatrun a command again and again
fmtformat a script to the GodspeedOS standard

The shared contract

Conventionsthe fourteen rules every utility above obeys

One page worth reading even if you skip the rest

poweroff documents a utility that does not exist. It was built, tested, and removed - the firmware's ACPI \_PTS method could not be executed without an AML interpreter, and adding one to reach a power state was not a trade worth making. The page records what was tried, what stopped it, and what would have to change.

That is the house style: a limitation that cannot be closed is written down, never quietly left (§26.7).