The Command Codex
The Hands that Make and Do: Exhaustive Reference for All 151 Native Commands
In fidelity to the original OopisOS Codex, every command in this reference answers three architectural questions: What it does (flags, options, and behaviors), How it works (internal execution trace through kernel, VFS, and stage manager), and Why it works (software engineering patterns, safety guarantees, and architectural rationale).
📂 File & Directory Management (17 Commands)
Foundational commands for inspecting, traversing, creating, moving, linking, and managing files and directories within the virtual POSIX file system.
| Command | Synopsis | Summary |
|---|---|---|
| ls | ls [-a] [-l] [-R] [-t] [-S] [-X] [-r] [-d] [-1] [FILE...] |
List information about the FILEs (the current directory by default) |
| cd | cd [directory] |
Changes the current working directory of the shell to the specified directory |
| mkdir | mkdir [-p] [DIRECTORY]... |
Create the DIRECTORY(ies), if they do not already exist |
| rmdir | rmdir [-p] DIRECTORY... |
Removes the DIRECTORY(ies), if they are empty |
| touch | touch [OPTION]... FILE... |
Update the access and modification times of each FILE to the specified time, |
| cp | cp [OPTION]... SOURCE... DEST |
Copy SOURCE to DEST, or multiple SOURCE(s) to a DIRECTORY |
| mv | mv [SOURCE] [DESTINATION]
mv [SOURCE...] [DIRECTORY] |
Renames SOURCE to DESTINATION, or moves SOURCE(s) to DIRECTORY |
| rename | rename OLD_NAME NEW_NAME |
Renames a file from OLD_NAME to NEW_NAME within the current directory |
| rm | rm [OPTION]... [FILE]... |
Removes each specified file |
| find | find [path...] [expression] |
The find utility recursively descends the directory tree for each path, evaluating an expression for each file |
| tree | tree [-d] [-C] [-L level] [DIRECTORY] |
Recursively displays the directory structure of a given path in a |
| du | du [OPTION]... [FILE]... |
Summarize disk usage of the set of FILEs, recursively for directories |
| df | df [OPTION]... |
Show information about the virtual file system, including total size, used space, available space, and the percentage of space used |
| ln | ln -s TARGET LINK_NAME |
Create a symbolic link named LINK_NAME which points to TARGET |
| mount | mount host <mount_point> |
Mounts a folder from the host computer into the FractalOS Virtual File System |
| clearfs | clearfs |
Removes all files and subdirectories within the current user's home directory, resetting it to a clean slate |
| binder | binder <sub-command> [options] |
Manages |
ls : LS Utility
SYNOPSIS: ls [-a] [-l] [-R] [-t] [-S] [-X] [-r] [-d] [-1] [FILE...]
List information about the FILEs (the current directory by default).
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that ls cannot corrupt system state or bypass security boundaries.
cd : CD Utility
SYNOPSIS: cd [directory]
Changes the current working directory of the shell to the specified directory. If no directory is given, it defaults to the current user's home directory.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
change_directory) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the cd command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
mkdir : MKDIR Utility
SYNOPSIS: mkdir [-p] [DIRECTORY]...
Create the DIRECTORY(ies), if they do not already exist.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that mkdir cannot corrupt system state or bypass security boundaries.
rmdir : RMDIR Utility
SYNOPSIS: rmdir [-p] DIRECTORY...
Removes the DIRECTORY(ies), if they are empty.
Options & Flags:
-p, --parentsremove DIRECTORY and its ancestors. For instance,`rmdir -p a/b/c` is similar to `rmdir a/b/c a/b a`.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that rmdir cannot corrupt system state or bypass security boundaries.
touch : TOUCH Utility
SYNOPSIS: touch [OPTION]... FILE...
Update the access and modification times of each FILE to the specified time, or the current time if no time is given. A FILE argument that does not exist is created empty.
Options & Flags:
-d, --date=STRINGParse STRING and use it instead of current time (e.g., "1 day ago").-t STAMPUse [[CC]YY]MMDDhhmm[.ss] instead of current time.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that touch cannot corrupt system state or bypass security boundaries.
cp : CP Utility
SYNOPSIS: cp [OPTION]... SOURCE... DEST
Copy SOURCE to DEST, or multiple SOURCE(s) to a DIRECTORY.
Options & Flags:
-f, --forceIf a destination file cannot be opened, remove it and try again.-i, --interactivePrompt before overwriting an existing file.-p, --preservePreserve the original file's mode, ownership, and timestamps.-r, -R, --recursiveCopy directories and their contents recursively.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
confirm) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the cp command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
mv : MV Utility
SYNOPSIS: mv [SOURCE] [DESTINATION]
mv [SOURCE...] [DIRECTORY]
Renames SOURCE to DESTINATION, or moves SOURCE(s) to DIRECTORY. If the last argument is an existing directory, the source file is moved into that directory.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that mv cannot corrupt system state or bypass security boundaries.
rename : RENAME Utility
SYNOPSIS: rename OLD_NAME NEW_NAME
Renames a file from OLD_NAME to NEW_NAME within the current directory. This command does not move files across directories. For that, use 'mv'.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that rename cannot corrupt system state or bypass security boundaries.
rm : RM Utility
SYNOPSIS: rm [OPTION]... [FILE]...
Removes each specified file. By default, it does not remove directories. It refuses to remove '.' or '..' (the directory you are in, or its parent) and '/'. To delete a directory, name it: rm -r old_project
Options & Flags:
-f, --forceignore nonexistent files and arguments, never prompt-iprompt before every removal-r, -R, --recursiveremove directories and their contents recursively
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
confirm) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the rm command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
find : FIND Utility
SYNOPSIS: find [path...] [expression]
The find utility recursively descends the directory tree for each path, evaluating an expression for each file.
Options & Flags:
-name <pattern>File name matches shell pattern (e.g., "*.txt").-type <f|d>File is of type f (file) or d (directory).-perm <mode>File's permission bits are exactly mode (octal).-oOR; the preceding expression is logically OR'd with the following one.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
execute_commands) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the find command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
tree : TREE Utility
SYNOPSIS: tree [-d] [-C] [-L level] [DIRECTORY]
Recursively displays the directory structure of a given path in a tree-like format. If no directory is specified, it lists the current directory.
Options & Flags:
-dList directories only.-L levelDescend only 'level' directories deep.-CColour the names: directories blue, symlinks cyan, executablesgreen. The colour codes travel with the text, so they end up inpipes and files too, same as the real thing.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that tree cannot corrupt system state or bypass security boundaries.
du : DU Utility
SYNOPSIS: du [OPTION]... [FILE]...
Summarize disk usage of the set of FILEs, recursively for directories. Sizes are displayed in 1K blocks by default.
Options & Flags:
-h, --human-readablePrint sizes in human readable format (e.g., 1K, 234M, 2G).-s, --summarizeDisplay only a total for each argument, not for subdirectories.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that du cannot corrupt system state or bypass security boundaries.
df : DF Utility
SYNOPSIS: df [OPTION]...
Show information about the virtual file system, including total size, used space, available space, and the percentage of space used.
Options & Flags:
-h, --human-readablePrint sizes in powers of 1024 (e.g., 1K, 234M, 2G).
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that df cannot corrupt system state or bypass security boundaries.
ln : LN Utility
SYNOPSIS: ln -s TARGET LINK_NAME
Create a symbolic link named LINK_NAME which points to TARGET. Hard links are not supported.
Options & Flags:
-s, --symbolicMake a symbolic link instead of a hard link. This is currently the only supported mode.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that ln cannot corrupt system state or bypass security boundaries.
mount : MOUNT Utility
SYNOPSIS: mount host <mount_point>
Mounts a folder from the host computer into the FractalOS Virtual File System. This command is only available in portable mode (Desktop app). When executed, it will open a host folder selection dialog. All files inside the host folder will become readable and writable within FractalOS. Note: Python scripts executed within FractalOS cannot dynamically `open()` host files because the python environment is isolated. Standard commands like `cat`, `grep`, and the `editor` fully support host files.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
mount_host) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the mount command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
clearfs : CLEARFS Utility
SYNOPSIS: clearfs
Removes all files and subdirectories within the current user's home directory, resetting it to a clean slate. This is a destructive and irreversible operation that requires confirmation. For safety, this command cannot be run by the 'root' user.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
confirm) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the clearfs command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
binder : BINDER Utility
SYNOPSIS: binder <sub-command> [options]
Manages .binder files, which are JSON files that group related project files together into sections. This allows for bulk operations on a set of files, even if they are in different directories.
Options & Flags:
-s, --section <name>Specify a section name when adding files. Defaults to 'general'.SUB-COMMANDS:create <name>Creates a new, empty binder file.add <binder> <path>Adds a file or directory path to a binder. Use with -s to specify a section.list <binder>
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
execute_commands) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the binder command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🔀 Text Processing & Pipeline Filters (20 Commands)
The stream-processing engine of FractalOS. These commands receive text through pipes or files, performing regex transforms, slicing, sorting, hashing, and formatting.
| Command | Synopsis | Summary |
|---|---|---|
| cat | cat [-n] [FILE]... |
The cat utility reads files sequentially, writing them to the standard output |
| head | head [OPTION]... [FILE]... |
Print the first 10 lines of each FILE to standard output |
| tail | tail [OPTION]... [FILE]... |
Print the last 10 lines of each FILE to standard output |
| grep | grep [OPTION...] PATTERNS [FILE...] |
grep searches for PATTERNS in each FILE |
| sed | sed [SCRIPT]... [FILE]... |
sed is a stream editor |
| awk | awk [-F fs] 'program' [file ...] |
The awk utility executes programs written in the awk programming language, which is specialized for textual data manipulation |
| cut | cut OPTION... [FILE]... |
Print selected parts of lines from each FILE to standard output |
| tr | tr [OPTION]... SET1 [SET2] |
Translate, squeeze, and/or delete characters from standard input, writing to standard output |
| sort | sort [OPTION]... [FILE]... |
Write sorted concatenation of all FILE(s) to standard output |
| uniq | uniq [OPTION]... [FILE]... |
Filter adjacent matching lines from input, writing to output |
| wc | wc [OPTION]... [FILE]... |
Print newline, word, and byte counts for each FILE, and a total line if |
| nl | nl [FILE]... |
Write each FILE to standard output, with line numbers added to |
| shuf | shuf [OPTION]... [FILE]
shuf -e [OPTION]... [ARG]...
shuf -i LO-HI [OPTION]... |
Write a random permutation of the input lines to standard output |
| csplit | csplit [OPTION]... FILE PATTERN... |
Output pieces of FILE separated by PATTERN(s) to files 'xx00', 'xx01', etc |
| xargs | [command] | xargs [-I replace-str] [utility [argument ...]] |
The xargs utility reads space or newline delimited strings from standard |
| diff | diff [OPTION]... FILE1 FILE2 |
Compare files line by line |
| patch | patch [ORIGINALFILE] [PATCHFILE] |
patch takes a patch file containing a difference listing produced |
| comm | comm [OPTION]... FILE1 FILE2 |
Compare sorted files FILE1 and FILE2 line by line |
| more | more [file] |
more is a filter for paging through text one screenful at a time |
| less | less [file...] |
Less is a program similar to 'more', but it allows backward movement in the file as well as forward movement |
cat : CAT Utility
SYNOPSIS: cat [-n] [FILE]...
The cat utility reads files sequentially, writing them to the standard output. The FILE operands are processed in command-line order. If FILE is a single dash ('-') or absent, cat reads from the standard input.
Options & Flags:
-n, --numberNumber all output lines, starting with 1.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that cat cannot corrupt system state or bypass security boundaries.
head : HEAD Utility
SYNOPSIS: head [OPTION]... [FILE]...
Print the first 10 lines of each FILE to standard output. With no FILE, or when FILE is -, read standard input.
Options & Flags:
-n, --lines=COUNTPrint the first COUNT lines instead of the first 10.-c, --bytes=COUNTPrint the first COUNT bytes.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that head cannot corrupt system state or bypass security boundaries.
tail : TAIL Utility
SYNOPSIS: tail [OPTION]... [FILE]...
Print the last 10 lines of each FILE to standard output. With no FILE, or when FILE is -, read standard input.
Options & Flags:
-n, --lines=COUNTOutput the last COUNT lines, instead of the last 10.-c, --bytes=COUNTOutput the last COUNT bytes.-f, --followOutput appended data as the file grows.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that tail cannot corrupt system state or bypass security boundaries.
grep : GREP Utility
SYNOPSIS: grep [OPTION...] PATTERNS [FILE...]
grep searches for PATTERNS in each FILE. A PATTERN is a regular expression.
Options & Flags:
-i, --ignore-caseIgnore case distinctions in patterns and input data.-v, --invert-matchInvert the sense of matching, to select non-matching lines.-n, --line-numberPrefix each line of output with the 1-based line number.-c, --countSuppress normal output; instead print a count of matching lines.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that grep cannot corrupt system state or bypass security boundaries.
sed : SED Utility
SYNOPSIS: sed [SCRIPT]... [FILE]...
sed is a stream editor. A stream editor is used to perform basic text transformations on an input stream (a file or input from a pipeline). This version supports simple substitution.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that sed cannot corrupt system state or bypass security boundaries.
awk : AWK Utility
SYNOPSIS: awk [-F fs] 'program' [file ...]
The awk utility executes programs written in the awk programming language, which is specialized for textual data manipulation. A program consists of a series of patterns followed by actions. When input is read that matches a pattern, the corresponding action is executed.
Options & Flags:
-F fsDefine the input field separator to be the regular expression fs.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that awk cannot corrupt system state or bypass security boundaries.
cut : CUT Utility
SYNOPSIS: cut OPTION... [FILE]...
Print selected parts of lines from each FILE to standard output. With no FILE, or when FILE is -, read standard input.
Options & Flags:
-c, --characters=LISTSelect only these characters. LIST is a comma-separated list of numbers and ranges (e.g., 1,3,5-7).-f, --fields=LISTSelect only these fields. LIST is a comma-separated list of numbers and ranges.-d, --delimiter=DELIMUse DELIM instead of TAB for the field delimiter.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that cut cannot corrupt system state or bypass security boundaries.
tr : TR Utility
SYNOPSIS: tr [OPTION]... SET1 [SET2]
Translate, squeeze, and/or delete characters from standard input, writing to standard output.
Options & Flags:
-c, --complementUse the complement of SET1.-d, --deleteDelete characters in SET1, do not translate.-s, --squeeze-repeatsReplace each input sequence of a repeated character that is listed in SET1with a single occurrence of that character.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. tr operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
sort : SORT Utility
SYNOPSIS: sort [OPTION]... [FILE]...
Write sorted concatenation of all FILE(s) to standard output. With no FILE, or when FILE is -, read standard input. The command sorts lexicographically by default.
Options & Flags:
-n, --numeric-sortCompare according to string numerical value.-r, --reverseReverse the result of comparisons.-u, --uniqueOutput only the first of an equal run.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that sort cannot corrupt system state or bypass security boundaries.
uniq : UNIQ Utility
SYNOPSIS: uniq [OPTION]... [FILE]...
Filter adjacent matching lines from input, writing to output. Note: 'uniq' does not detect repeated lines unless they are adjacent. You may want to 'sort' the input first to group all identical lines.
Options & Flags:
-c, --countPrefix lines by the number of occurrences.-d, --repeatedOnly print duplicate lines, one for each group.-u, --uniqueOnly print lines that are not repeated.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that uniq cannot corrupt system state or bypass security boundaries.
wc : WC Utility
SYNOPSIS: wc [OPTION]... [FILE]...
Print newline, word, and byte counts for each FILE, and a total line if more than one FILE is specified. With no FILE, or when FILE is -, read standard input.
Options & Flags:
-c, --bytesPrint the byte counts.-l, --linesPrint the newline counts.-w, --wordsPrint the word counts.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that wc cannot corrupt system state or bypass security boundaries.
nl : NL Utility
SYNOPSIS: nl [FILE]...
Write each FILE to standard output, with line numbers added to non-empty lines. With no FILE, or when FILE is -, read standard input.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that nl cannot corrupt system state or bypass security boundaries.
shuf : SHUF Utility
SYNOPSIS: shuf [OPTION]... [FILE]
shuf -e [OPTION]... [ARG]...
shuf -i LO-HI [OPTION]...
Write a random permutation of the input lines to standard output.
Options & Flags:
-e, --echotreat each ARG as an input line-i, --input-range=LO-HItreat each number in range LO-HI as an input line-n, --head-count=COUNToutput at most COUNT lines
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that shuf cannot corrupt system state or bypass security boundaries.
csplit : CSPLIT Utility
SYNOPSIS: csplit [OPTION]... FILE PATTERN...
Output pieces of FILE separated by PATTERN(s) to files 'xx00', 'xx01', etc. In this version, PATTERN must be a line number.
Options & Flags:
-f, --prefix=PREFIXUse PREFIX instead of 'xx' for the output file names.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that csplit cannot corrupt system state or bypass security boundaries.
xargs : XARGS Utility
SYNOPSIS: [command] | xargs [-I replace-str] [utility [argument ...]]
The xargs utility reads space or newline delimited strings from standard input and executes the specified utility with the strings as arguments.
Options & Flags:
-I replace-strReplace occurrences of replace-str in the utility and argumentswith names read from standard input. This executes the utilityonce for each input line.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
execute_commands) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the xargs command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
diff : DIFF Utility
SYNOPSIS: diff [OPTION]... FILE1 FILE2
Compare files line by line. By default, it produces output in a context format.
Options & Flags:
-u, --unifiedOutput 3 lines of unified context. This is the most common format for creating patch files.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that diff cannot corrupt system state or bypass security boundaries.
patch : PATCH Utility
SYNOPSIS: patch [ORIGINALFILE] [PATCHFILE]
patch takes a patch file containing a difference listing produced by the diff program and applies those differences to an original file, producing a patched version.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that patch cannot corrupt system state or bypass security boundaries.
comm : COMM Utility
SYNOPSIS: comm [OPTION]... FILE1 FILE2
Compare sorted files FILE1 and FILE2 line by line. With no options, produce three-column output. Column one contains lines unique to FILE1, column two contains lines unique to FILE2, and column three contains lines common to both files.
Options & Flags:
-1Suppress column 1 (lines unique to FILE1).-2Suppress column 2 (lines unique to FILE2).-3Suppress column 3 (lines that appear in both files).
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that comm cannot corrupt system state or bypass security boundaries.
more : MORE Utility
SYNOPSIS: more [file]
more is a filter for paging through text one screenful at a time. It allows you to view the contents of a file or piped command output page by page. Press SPACE or 'f' to advance to the next page, and 'q' to quit.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
page_output) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the more command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
less : LESS Utility
SYNOPSIS: less [file...]
Less is a program similar to 'more', but it allows backward movement in the file as well as forward movement. It opens a full-screen pager to view the content.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
page_output) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the less command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🧠 Living Shell & Kinetic AI (7 Commands)
Commands interfacing with Samwise and the BoneAmanita driver, powering autonomous agent execution, atomic code synthesis, storyboard generation, and document analysis.
| Command | Synopsis | Summary |
|---|---|---|
| samwise | samwise [OPTIONS] "<prompt>" |
The samwise command is the bridge to the AI Kernel |
| forge | forge [--literal] <filename> "<content>" |
Writes the supplied text |
| planner | planner <project> [sub-command] [options] |
Manages project plans |
| storyboard | storyboard [OPTIONS] [path]
<command> | storyboard [OPTIONS] |
Analyzes a set of files to describe their collective purpose and structure |
| remix | remix [-p provider] [-m model] <file1> <file2> |
The remix command uses an AI to read two source files, understand the |
| chidi | chidi [-n] [-p provider] [-m model] [path]
<command> | chidi |
Chidi is a powerful graphical tool that leverages a Large Language |
| character | character <sub-command> <character_name> [options] |
Manages all aspects of a TTRPG character by creating a centralized binder and providing easy access to journals, quest logs, and character sheets |
samwise : SAMWISE Utility
SYNOPSIS: samwise [OPTIONS] "<prompt>"
The samwise command is the bridge to the AI Kernel. It has two primary modes: 1. **Agent Mode (Default):** A helpful assistant that answers questions. 2. **Autopilot Mode (--autopilot):** A kinetic driver (BoneAmanita) that EXECUTES tasks.
Options & Flags:
-c, --chatOpen an interactive, graphical chat session.-a, --autopilotEngage BoneAmanita Autopilot. The AI will DIRECTLY execute commands tofulfill your request. Use with caution.-f, --forceOverride Safety Interlocks. Allows the Autopilot to perform High Voltageactions (like mass deletion) without braking.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Kinetic LLM Orchestration: Assembles system context, computes operation voltage safety scores, dispatches requests via
ai_manager, and synthesizes output. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the samwise command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
forge : FORGE Utility
SYNOPSIS: forge [--literal] <filename> "<content>"
Writes the supplied text. After shell quoting, \n becomes a newline and \\ becomes a literal backslash. Other escapes are preserved. --literal disables this decoding and writes the argument exactly as received. Single-quote shell content to preserve its backslashes. With double-quoted shell content, double backslashes again for the shell layer.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that forge cannot corrupt system state or bypass security boundaries.
planner : PLANNER Utility
SYNOPSIS: planner <project> [sub-command] [options]
Manages project plans. By default, it operates on .planner files in the user's ~/.plans/ directory. When run as root, it manages system-wide projects in /etc/projects/.
Options & Flags:
This command takes no options.SUB-COMMANDScreate <name>Creates a new project plan.listDisplays the status board for <project>. (This is the default action).add "<task>"Adds a new task to the plan.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
beep,execute_commands) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the planner command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
storyboard : STORYBOARD Utility
SYNOPSIS: storyboard [OPTIONS] [path]
<command> | storyboard [OPTIONS]
Analyzes a set of files to describe their collective purpose and structure. It can be run on a directory path or accept a list of file paths from standard input (e.g., from `find` or `ls`).
Options & Flags:
--mode <mode>The analysis mode ('code' or 'prose'). Defaults to 'code'.--summaryGenerate a single, concise paragraph summary instead of a detailed analysis.--ask "<question>"Ask a specific question about the provided files.--provider <name>Specify the AI provider (e.g., 'gemini', 'ollama'). Defaults to 'ollama'.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Kinetic LLM Orchestration: Assembles system context, computes operation voltage safety scores, dispatches requests via
ai_manager, and synthesizes output. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the storyboard command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
remix : REMIX Utility
SYNOPSIS: remix [-p provider] [-m model] <file1> <file2>
The remix command uses an AI to read two source files, understand the core ideas of each, and then generate a new, summarized article that synthesizes the information from both.
Options & Flags:
-p, --provider <name>Specify the AI provider (e.g., 'gemini', 'ollama'). Defaults to 'ollama'.-m, --model <name>Specify the exact model name to use for the chosen provider.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Kinetic LLM Orchestration: Assembles system context, computes operation voltage safety scores, dispatches requests via
ai_manager, and synthesizes output. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the remix command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
chidi : CHIDI Utility
SYNOPSIS: chidi [-n] [-p provider] [-m model] [path]
<command> | chidi
Chidi is a powerful graphical tool that leverages a Large Language Model (LLM) to help you understand and interact with your files in FractalOS. It can summarize documents, suggest insightful questions, and answer your questions based on the content of the files you provide. When pointed at a .story directory, Chidi will provide a narrative summary of the project's history.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Kinetic LLM Orchestration: Assembles system context, computes operation voltage safety scores, dispatches requests via
ai_manager, and synthesizes output. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the chidi command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
character : CHARACTER Utility
SYNOPSIS: character <sub-command> <character_name> [options]
Manages all aspects of a TTRPG character by creating a centralized binder and providing easy access to journals, quest logs, and character sheets.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
execute_commands) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the character command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🌐 Distributed Mesh & Networking (11 Commands)
Peer-to-peer mesh operations over WebRTC data channels and local BroadcastChannel. Enables multi-node terminal mirroring, live telemetry, and direct file transfer.
| Command | Synopsis | Summary |
|---|---|---|
| peers | peers [--ping | -p] [--json | -j] [--gui | -g]
peers info <node-id>
peers ping |
Displays active peer nodes discovered on the FractalOS mesh network |
| attach | attach [-l | --list]
attach [-d | --detach]
attach <instanceId> |
Attach your local terminal to a remote FractalOS instance on the mesh network |
| detach | detach |
Leaves the currently attached remote mesh terminal session and returns |
| wall | wall <message>
<command> | wall |
Displays a broadcast message across the terminals of all connected |
| talk | talk <targetId> "<message>" |
Sends a direct message to a specific FractalOS node across the mesh |
| mesh_cp | mesh-cp <local_file> <targetId>:<remote_path>
mesh-cp <targetId>:<remote_file> <local_path>
mesh-cp send <targetId> <local_file> [<remote_path>]
mesh-cp pull <targetId> <remote_file> [<local_path>] |
Transfers files directly between FractalOS nodes over the mesh network |
| mesh_agent | mesh-agent <nodeId> <prompt> [OPTIONS]
mesh-agent policy [set <key> <value> | reset]
mesh-agent log [limit] |
Dispatches sub-tasks, queries, or autopilot operations to a peer node's 'samwise' |
| swarm | swarm [status]
swarm policy [set <key> <value> | reset]
swarm log [limit]
swarm run <nodeId> <prompt> [OPTIONS] |
The swarm command provides a high-level cockpit for multi-agent swarm operations across |
| scp | scp <source> <destination> |
Transfers files directly between FractalOS nodes over the mesh network |
| nc | nc [-l] [-e] | [<targetId> "<message>"] |
A utility for network communication between FractalOS instances |
| netstat | netstat [--mesh | -m] [--gui | -g] [--ping | -p] |
Displays a list of all discovered FractalOS instances and their |
peers : PEERS Utility
SYNOPSIS: peers [--ping | -p] [--json | -j] [--gui | -g]
peers info <node-id>
peers ping
Displays active peer nodes discovered on the FractalOS mesh network. Shows node IDs, remote usernames, transport layers (WebRTC, BroadcastChannel, WebSocket), round-trip ping latency, and shared capabilities (remote shell, p2p file transfer, multiplayer gaming).
Options & Flags:
--ping, -pActively ping all discovered nodes and display round-trip latency in ms.--json, -jOutput raw JSON data for shell scripting and automation.--gui, -gLaunch the interactive fullscreen Mesh Network Monitor TUI app.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app,peers_display,peers_info) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the peers command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
attach : ATTACH Utility
SYNOPSIS: attach [-l | --list]
attach [-d | --detach]
attach <instanceId>
Attach your local terminal to a remote FractalOS instance on the mesh network. Once attached, commands entered locally execute in the remote host's environment, with outputs streamed back in real time. Both host and client see commands in a shared pair-programming terminal session.
Options & Flags:
-l, --list List discovered nodes available for attachment.-d, --detach Detach from the currently active remote session.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
mesh_attach,mesh_attach_list,mesh_detach) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the attach command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
detach : DETACH Utility
SYNOPSIS: detach
Leaves the currently attached remote mesh terminal session and returns to the local terminal shell prompt.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
mesh_detach) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the detach command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
wall : WALL Utility
SYNOPSIS: wall <message>
<command> | wall
Displays a broadcast message across the terminals of all connected FractalOS mesh nodes. Reads from arguments or standard input.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
mesh_wall) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the wall command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
talk : TALK Utility
SYNOPSIS: talk <targetId> "<message>"
Sends a direct message to a specific FractalOS node across the mesh network, alerting the recipient terminal.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
mesh_talk) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the talk command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
mesh_cp : MESH_CP Utility
SYNOPSIS: mesh-cp <local_file> <targetId>:<remote_path>
mesh-cp <targetId>:<remote_file> <local_path>
mesh-cp send <targetId> <local_file> [<remote_path>]
mesh-cp pull <targetId> <remote_file> [<local_path>]
Transfers files directly between FractalOS nodes over the mesh network (WebRTC / WebSockets / BroadcastChannel) without third-party cloud storage.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
mesh_file_pull,mesh_file_send) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the mesh_cp command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
mesh_agent : MESH_AGENT Utility
SYNOPSIS: mesh-agent <nodeId> <prompt> [OPTIONS]
mesh-agent policy [set <key> <value> | reset]
mesh-agent log [limit]
Dispatches sub-tasks, queries, or autopilot operations to a peer node's 'samwise' agent across the FractalOS distributed mesh network (via WebSockets, WebRTC, or BroadcastChannel).
Options & Flags:
--autopilot, -aExecutes the delegated prompt using BoneAmanita Autopilot mode on the remote node.--max-voltage, -v, -V <voltage>Specifies a strict voltage budget cap for the task. If remote planning exceedsthis limit, the task will disengage without executing kinetic actions.--dry-runGenerates and scores the remote plan with voltage audit, but does not executeany kinetic steps.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
mesh_agent_delegate) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the mesh_agent command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
swarm : SWARM Utility
SYNOPSIS: swarm [status]
swarm policy [set <key> <value> | reset]
swarm log [limit]
swarm run <nodeId> <prompt> [OPTIONS]
The swarm command provides a high-level cockpit for multi-agent swarm operations across the FractalOS distributed mesh. It allows node operators to inspect and configure the node's voltage limits, physical hardware GPIO permissions, and provenance audit log.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. swarm operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
scp : SCP Utility
SYNOPSIS: scp <source> <destination>
Transfers files directly between FractalOS nodes over the mesh network. Syntax and behavior are identical to 'mesh-cp'.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. scp operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
nc : NC Utility
SYNOPSIS: nc [-l] [-e] | [<targetId> "<message>"]
A utility for network communication between FractalOS instances. It can send direct messages or set up a listener to receive them. -e, --exec (with -l) executes incoming messages as commands. WARNING: --exec is a security risk. Use with trusted peers only.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
netcat_listen,netcat_send) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the nc command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
netstat : NETSTAT Utility
SYNOPSIS: netstat [--mesh | -m] [--gui | -g] [--ping | -p]
Displays a list of all discovered FractalOS instances and their connection status, including your own instance ID. When given --mesh, prints detailed mesh node presence with latency and shared capabilities.
Options & Flags:
--mesh, -mDisplays full mesh node presence table with latency and capabilities.--ping, -pMeasures round-trip ping latency to each peer.--gui, -gLaunches the graphical Mesh Network Monitor app.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app,netstat_display,peers_display) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the netstat command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🖥️ Terminal Multiplexing & Window Control (9 Commands)
Commands managing terminal split panes (tmux-style multiplexing), floating/docked application viewports, status lines, and focus controls.
| Command | Synopsis | Summary |
|---|---|---|
| split_h | split-h [-c <command>] |
Splits the active terminal pane into two horizontal (top and bottom) panes |
| split_v | split-v [-c <command>] |
Splits the active terminal pane into two vertical (left and right) panes |
| split | split [-v|-h] [-c <command>]
split list
split focus <paneId|next|prev>
split close [paneId]
split zoom [paneId] |
The split command multiplexes the FractalOS terminal interface into multiple |
| panes | panes |
Displays a list of all active terminal multiplexer panes, their identifiers, |
| close_pane | close-pane [paneId|index] |
Closes the specified terminal split pane (or the currently focused pane if omitted) |
| focus | focus <paneId|index|next|prev> |
Switches active input focus and working directory context to the specified |
| wm | wm [list]
wm focus <window_id>
wm mode <window_id> <mode>
wm dock <window_id> [right|left|bottom]
wm float <window_id>
wm min <window_id>
wm restore <window_id>
wm close <window_id>
wm tile |
Manages interactive TUI windows for overlay and desktop applications |
| window | window [options] [arguments] |
Executes the window utility |
| status | status
status bar [on|off]
status mute [on|off]
status notifications
status clear |
Displays a real-time status summary of FractalOS system components, |
split_h : SPLIT_H Utility
SYNOPSIS: split-h [-c <command>]
Splits the active terminal pane into two horizontal (top and bottom) panes. Shortcut for 'split -h'.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. split_h operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
split_v : SPLIT_V Utility
SYNOPSIS: split-v [-c <command>]
Splits the active terminal pane into two vertical (left and right) panes. Shortcut for 'split -v'.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. split_v operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
split : SPLIT Utility
SYNOPSIS: split [-v|-h] [-c <command>]
split list
split focus <paneId|next|prev>
split close [paneId]
split zoom [paneId]
The split command multiplexes the FractalOS terminal interface into multiple horizontal or vertical split panes with independent working directories, command histories, and output buffers.
Options & Flags:
--vertical, -vSplits the current pane vertically (side-by-side, default).--horizontal, -hSplits the current pane horizontally (top and bottom).--command, -c <cmd>Automatically executes <cmd> inside the newly created pane upon creation.--list, -lLists all currently active panes, their working directories, and active status.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
multiplexer_action) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the split command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
panes : PANES Utility
SYNOPSIS: panes
Displays a list of all active terminal multiplexer panes, their identifiers, current working directories, and whether they are active or zoomed.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. panes operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
close_pane : CLOSE_PANE Utility
SYNOPSIS: close-pane [paneId|index]
Closes the specified terminal split pane (or the currently focused pane if omitted). When only one pane remains, it cannot be closed.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. close_pane operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
focus : FOCUS Utility
SYNOPSIS: focus <paneId|index|next|prev>
Switches active input focus and working directory context to the specified terminal pane. Supports pane index (e.g. 'focus 2'), pane ID (e.g. 'focus pane-2'), or relative navigation ('focus next', 'focus prev').
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. focus operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
wm : WM Utility
SYNOPSIS: wm [list]
wm focus <window_id>
wm mode <window_id> <mode>
wm dock <window_id> [right|left|bottom]
wm float <window_id>
wm min <window_id>
wm restore <window_id>
wm close <window_id>
wm tile
Manages interactive TUI windows for overlay and desktop applications (Editor, Paint, Top, Adventure, Netgame, Peers, Chidi, etc.).
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
window_action) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the wm command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
window : WINDOW Utility
SYNOPSIS: window [options] [arguments]
Executes the window utility.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. window operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
status : STATUS Utility
SYNOPSIS: status
status bar [on|off]
status mute [on|off]
status notifications
status clear
Displays a real-time status summary of FractalOS system components, including working directory, active terminal panes, background jobs, connected mesh peers, audio mute status, AI agent state, and recent alerts.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
status_action) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the status command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🛡️ System Identity, Security & Access (16 Commands)
User authentication, group memberships, session switching, and superuser privilege escalation governed by PBKDF2 cryptography and /etc/sudoers.
| Command | Synopsis | Summary |
|---|---|---|
| login | login <username> [password] |
The login utility logs a new user into the system |
| logout | logout |
The logout utility terminates a session |
| su | su [username] [password] |
The su utility allows a user to run a new shell as another user |
| sudo | sudo command [args...] |
sudo allows a permitted user to execute a command as the superuser (root), |
| visudo | visudo |
visudo edits the sudoers file in a safe way |
| whoami | whoami |
Prints the user name associated with the current effective user ID |
| who | who |
Print information about users who are currently logged in |
| useradd | useradd [username] |
Creates a new user account with the specified username |
| removeuser | removeuser [-r] [-f] username |
Removes a user account from the system |
| passwd | passwd [username] |
The passwd utility changes the password for the specified user account |
| usermod | usermod [OPTIONS] username |
Modifies the properties of an existing user account |
| groupadd | groupadd group_name |
Creates a new group with the specified name |
| groupdel | groupdel group_name |
Deletes an existing group |
| groups | groups [USERNAME] |
Print group memberships for each USERNAME |
| listusers | listusers |
The listusers command displays a list of all user accounts that currently exist on the system |
| committee | committee --create <name> --members <user1>,<user2>... |
Automates the creation of a user group, a shared project directory (/home/project_<name>), and the assignment of appropriate permissions for collaborative work |
login : LOGIN Utility
SYNOPSIS: login <username> [password]
The login utility logs a new user into the system. If a password is not provided on the command line, the user will be prompted for one.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
login) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the login command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
logout : LOGOUT Utility
SYNOPSIS: logout
The logout utility terminates a session. If this is the last active session for the user, they will be returned to the Guest user session.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
logout) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the logout command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
su : SU Utility
SYNOPSIS: su [username] [password]
The su utility allows a user to run a new shell as another user. If a username is not provided, it defaults to 'root'. If a password is not provided on the command line, the user will be prompted for one interactively. To return to your original session, type 'logout'.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
su) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the su command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
sudo : SUDO Utility
SYNOPSIS: sudo command [args...]
sudo allows a permitted user to execute a command as the superuser (root), as specified by the security policy in the /etc/sudoers file. The user will be prompted for their own password to authenticate.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Security & Authority Verification: Validates user identity, group affiliations, or cryptographic credentials against system authority managers before proceeding.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sudo_exec) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the sudo command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
visudo : VISUDO Utility
SYNOPSIS: visudo
visudo edits the sudoers file in a safe way. It launches the system editor and, upon saving, will perform a syntax check before applying
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the visudo command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
whoami : WHOAMI Utility
SYNOPSIS: whoami
Prints the user name associated with the current effective user ID.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. whoami operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
who : WHO Utility
SYNOPSIS: who
Print information about users who are currently logged in. This command lists all active sessions in the current user's stack, showing the order in which users were switched using the 'su' command.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. who operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
useradd : USERADD Utility
SYNOPSIS: useradd [username]
Creates a new user account with the specified username. This command also creates a primary group with the same name and a home directory at /home/<username>. If run interactively, it will prompt for a new password. This command requires root privileges.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sync_user_and_group_state,useradd) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the useradd command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
removeuser : REMOVEUSER Utility
SYNOPSIS: removeuser [-r] [-f] username
Removes a user account from the system. This command requires root privileges.
Options & Flags:
-r, --remove-homeRemove the user's home directory.-f, --forceNever prompt for confirmation, even if the user is logged in.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Security & Authority Verification: Validates user identity, group affiliations, or cryptographic credentials against system authority managers before proceeding.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
removeuser,sync_user_and_group_state) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the removeuser command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
passwd : PASSWD Utility
SYNOPSIS: passwd [username]
The passwd utility changes the password for the specified user account. If no username is provided, it changes the password for the current user. Running this command will begin an interactive prompt to enter the new password. A regular user may only change their own password. The super-user (root) may change the password for any account.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
passwd) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the passwd command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
usermod : USERMOD Utility
SYNOPSIS: usermod [OPTIONS] username
Modifies the properties of an existing user account. This command requires root privileges.
Options & Flags:
-aG, --append-groups GROUPAdd the user to the supplementary GROUP.-g, --gid GROUPSet the user's primary group.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Security & Authority Verification: Validates user identity, group affiliations, or cryptographic credentials against system authority managers before proceeding.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sync_group_state) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the usermod command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
groupadd : GROUPADD Utility
SYNOPSIS: groupadd group_name
Creates a new group with the specified name. This command can only be run by the root user. Group names cannot contain spaces.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Security & Authority Verification: Validates user identity, group affiliations, or cryptographic credentials against system authority managers before proceeding.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sync_group_state) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the groupadd command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
groupdel : GROUPDEL Utility
SYNOPSIS: groupdel group_name
Deletes an existing group. You cannot delete the primary group of an existing user. This command can only be run by the root user.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Security & Authority Verification: Validates user identity, group affiliations, or cryptographic credentials against system authority managers before proceeding.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sync_group_state) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the groupdel command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
groups : GROUPS Utility
SYNOPSIS: groups [USERNAME]
Print group memberships for each USERNAME. If USERNAME is omitted, the command prints the groups for the current user.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Security & Authority Verification: Validates user identity, group affiliations, or cryptographic credentials against system authority managers before proceeding.
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. groups operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
listusers : LISTUSERS Utility
SYNOPSIS: listusers
The listusers command displays a list of all user accounts that currently exist on the system.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. listusers operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
committee : COMMITTEE Utility
SYNOPSIS: committee --create <name> --members <user1>,<user2>...
Automates the creation of a user group, a shared project directory (/home/project_<name>), and the assignment of appropriate permissions for collaborative work. It also automatically creates a project planner file inside the new directory. This command can only be run by the root user.
Options & Flags:
-c, --create <name>The name for the new committee. This will be used for the group name and the project directory. (Required)-m, --members <user1>,<user2>...A comma-separated list of existing users to add to the new group. (Required)
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sync_group_state) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the committee command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🔑 File Permissions & Metadata (3 Commands)
Commands directly modifying the inode metadata of virtual filesystem nodes, including POSIX octal modes, user ownership, and group ownership.
| Command | Synopsis | Summary |
|---|---|---|
| chmod | chmod [-R] MODE FILE... |
Changes the file mode bits (permissions) of each given file according to mode, which must be an octal number (e |
| chown | chown [OPTION]... OWNER FILE... |
Changes the user ownership of each given FILE to OWNER |
| chgrp | chgrp [OPTION]... GROUP FILE... |
Changes the group ownership of each given FILE to GROUP |
chmod : CHMOD Utility
SYNOPSIS: chmod [-R] MODE FILE...
Changes the file mode bits (permissions) of each given file according to mode, which must be an octal number (e.g., 755, 644). Only the file's owner or the root user may change the mode of a file.
Options & Flags:
-R, --recursiveChange files and directories recursively.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that chmod cannot corrupt system state or bypass security boundaries.
chown : CHOWN Utility
SYNOPSIS: chown [OPTION]... OWNER FILE...
Changes the user ownership of each given FILE to OWNER. This command can only be run by the root user.
Options & Flags:
-R, -r, --recursiveOperate on files and directories recursively.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that chown cannot corrupt system state or bypass security boundaries.
chgrp : CHGRP Utility
SYNOPSIS: chgrp [OPTION]... GROUP FILE...
Changes the group ownership of each given FILE to GROUP. The user running the command must be root.
Options & Flags:
-R, -r, --recursiveOperate on files and directories recursively.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that chgrp cannot corrupt system state or bypass security boundaries.
📜 Shell Execution & Environment (13 Commands)
Scripting runners, environment variable scoping, command alias persistence, execution delays, and testing assertion utilities.
| Command | Synopsis | Summary |
|---|---|---|
| run | run SCRIPT [ARGUMENTS...] |
The run command reads and executes commands from a file in the current |
| check_fail | check_fail [-z] "<command_string>" |
A testing utility that executes a given command string |
| echo | echo [-e] [STRING]... |
Echo the STRING(s) to standard output, followed by a newline |
| printf | printf FORMAT [ARGUMENT]... |
Write formatted data to standard output |
| true | true |
Does nothing and returns true (success) |
| delay | delay <milliseconds> |
The delay command pauses execution for the specified number of milliseconds |
| agenda | agenda <sub-command> [options] |
Manages scheduled background tasks by modifying /etc/agenda |
| alias | alias [name[=value] ...] |
The `alias` command allows you to create shortcuts for longer or more complex commands |
| unalias | unalias alias_name ... |
Removes each specified alias from the current session's list of defined aliases |
| history | history [-c] |
Displays the command history list with line numbers |
| set | set [variable[=value]] |
Set or display environment variables |
| unset | unset [variable_name]... |
The unset command removes the specified environment variable(s) |
| clear | clear |
The clear utility clears the terminal screen of all previous output, moving the prompt to the top of the window |
run : RUN Utility
SYNOPSIS: run SCRIPT [ARGUMENTS...]
The run command reads and executes commands from a file in the current shell environment. It is useful for automating tasks. Script arguments can be accessed within the script using $1, $2, etc. It also supports non-interactive password setting for commands like 'useradd' or 'sudo' by placing the required password(s) on the line(s) immediately following the command.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
execute_script) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the run command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
check_fail : CHECK_FAIL Utility
SYNOPSIS: check_fail [-z] "<command_string>"
A testing utility that executes a given command string. It succeeds if the command fails. This is useful for writing automated test scripts.
Options & Flags:
-z, --check-emptyThe check succeeds if the command produces no standard output, regardless of its success or failure.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. check_fail operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
echo : ECHO Utility
SYNOPSIS: echo [-e] [STRING]...
Echo the STRING(s) to standard output, followed by a newline.
Options & Flags:
-eEnable interpretation of backslash escapes (e.g., \n for newline, \t for tab).
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. echo operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
printf : PRINTF Utility
SYNOPSIS: printf FORMAT [ARGUMENT]...
Write formatted data to standard output. Interprets backslash escapes and format specifiers.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. printf operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
true : TRUE Utility
SYNOPSIS: true
Does nothing and returns true (success).
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. true operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
delay : DELAY Utility
SYNOPSIS: delay <milliseconds>
The delay command pauses execution for the specified number of milliseconds. It is primarily used within scripts (executed via the 'run' command) to create timed sequences, demonstrations, or to wait for a background process.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
delay) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the delay command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
agenda : AGENDA Utility
SYNOPSIS: agenda <sub-command> [options]
Manages scheduled background tasks by modifying /etc/agenda.json. The AgendaDaemon process is responsible for executing these tasks.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that agenda cannot corrupt system state or bypass security boundaries.
alias : ALIAS Utility
SYNOPSIS: alias [name[=value] ...]
The `alias` command allows you to create shortcuts for longer or more complex commands. - Running `alias` with no arguments prints the list of all current aliases. - With a name and value (e.g., `alias ll='ls -l'`), it creates or redefines an alias. - With only a name, it prints the value of that specific alias.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sync_session_state) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the alias command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
unalias : UNALIAS Utility
SYNOPSIS: unalias alias_name ...
Removes each specified alias from the current session's list of defined aliases.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sync_session_state) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the unalias command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
history : HISTORY Utility
SYNOPSIS: history [-c]
Displays the command history list with line numbers.
Options & Flags:
-c, --clearClear the history list by deleting all entries.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Snapshot Tree Traversal: Traverses
.story/content-addressed blobs, updating commit manifests or rolling back VFS inodes. - Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. history operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
set : SET Utility
SYNOPSIS: set [variable[=value]]
Set or display environment variables. When run without arguments, it displays a list of all current environment variables. When a variable and value are provided, it sets or updates the variable.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sync_session_state) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the set command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
unset : UNSET Utility
SYNOPSIS: unset [variable_name]...
The unset command removes the specified environment variable(s). Once unset, a variable will no longer be available to commands or for expansion.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
sync_session_state) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the unset command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
clear : CLEAR Utility
SYNOPSIS: clear
The clear utility clears the terminal screen of all previous output, moving the prompt to the top of the window.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
clear_screen) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the clear command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
⚡ Process Management & Job Control (8 Commands)
Monitoring active foreground and background jobs, signaling processes (KILL, TERM, STOP, CONT), process tables, and system uptime.
| Command | Synopsis | Summary |
|---|---|---|
| ps | ps |
ps displays information about a selection of the active processes, |
| top | top [--dock|-d] [--float|-f] [--full] |
Provides a dynamic, real-time view of the processes running in FractalOS |
| kill | kill [-s sigspec] [pid | %job]...
kill -SIGNAME [pid | %job]... |
The kill utility sends a signal to the specified processes or jobs |
| bg | bg [%job_id | pid]... |
Resumes one or more stopped background jobs, keeping them in the background |
| fg | fg [%job_id] |
Resumes a stopped or background job and brings it to the foreground, giving it control of the terminal |
| jobs | jobs |
Lists the background jobs that were started from the current terminal, along with their status (Running, Stopped) and command |
| uptime | uptime |
Print the current time, how long the system has been running since the |
| date | date |
Displays the current time and date according to the system's clock |
ps : PS Utility
SYNOPSIS: ps
ps displays information about a selection of the active processes, including background jobs and their current status (e.g., Running, Stopped).
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. ps operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
top : TOP Utility
SYNOPSIS: top [--dock|-d] [--float|-f] [--full]
Provides a dynamic, real-time view of the processes running in FractalOS. The top command opens a process viewer window listing all active background jobs and system processes. By default it docks side-by-side with the terminal. Press 'q' or 'Escape' to quit.
Options & Flags:
-d, --dockDock side-by-side with the shell terminal (default).-f, --floatOpen in a floating, movable window.--fullOpen in fullscreen overlay mode.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the top command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
kill : KILL Utility
SYNOPSIS: kill [-s sigspec] [pid | %job]...
kill -SIGNAME [pid | %job]...
The kill utility sends a signal to the specified processes or jobs. If no signal is specified, the TERM signal is sent, which requests a clean termination.
Options & Flags:
-s, --signal <sigspec>Specify the signal to be sent. Common signals include TERM, KILL, and STOP.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
signal_job) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the kill command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
bg : BG Utility
SYNOPSIS: bg [%job_id | pid]...
Resumes one or more stopped background jobs, keeping them in the background. If no job_id is specified, the most recently stopped job is used. You can specify jobs by their job ID (e.g., %1) or their process ID (e.g., 1).
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
signal_job) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the bg command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
fg : FG Utility
SYNOPSIS: fg [%job_id]
Resumes a stopped or background job and brings it to the foreground, giving it control of the terminal. If no job_id is specified, the most recently backgrounded or stopped job is used.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
signal_job) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the fg command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
jobs : JOBS Utility
SYNOPSIS: jobs
Lists the background jobs that were started from the current terminal, along with their status (Running, Stopped) and command.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. jobs operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
uptime : UPTIME Utility
SYNOPSIS: uptime
Print the current time, how long the system has been running since the web page was loaded, and the number of users currently logged on.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. uptime operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
date : DATE Utility
SYNOPSIS: date
Displays the current time and date according to the system's clock. The output format is similar to the standard Unix date command. (Note: Setting the date is not supported in FractalOS).
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. date operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
🔒 Data Integrity, Cryptography & Compression (7 Commands)
Cryptographic hashing, cyclic redundancy checks, stream ciphers, and virtual archive compression/decompression.
| Command | Synopsis | Summary |
|---|---|---|
| base64 | base64 [OPTION]... [FILE] |
Base64 encode or decode FILE, or standard input, to standard output |
| cksum | cksum [FILE]... |
The cksum utility calculates and writes to standard output a single line for each input file |
| ocrypt | ocrypt [-d] password infile outfile |
Encrypts or decrypts a file using a password |
| xor | xor KEY [FILE] |
Encrypts or decrypts the given FILE or standard input using a repeating |
| zip | zip archive.zip file... |
zip is a compression and file packaging utility |
| unzip | unzip archive.zip [destination_dir] |
The unzip utility will extract files from a ZIP archive created by the 'zip' |
| fsck | fsck [--repair] |
fsck is used to check and optionally repair the virtual file system |
base64 : BASE64 Utility
SYNOPSIS: base64 [OPTION]... [FILE]
Base64 encode or decode FILE, or standard input, to standard output. With no FILE, or when FILE is -, read standard input.
Options & Flags:
-d, --decodedecode data
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that base64 cannot corrupt system state or bypass security boundaries.
cksum : CKSUM Utility
SYNOPSIS: cksum [FILE]...
The cksum utility calculates and writes to standard output a single line for each input file. The line consists of the CRC checksum of the file, the number of bytes in the file, and the name of the file. If no file is specified, cksum reads from standard input.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that cksum cannot corrupt system state or bypass security boundaries.
ocrypt : OCRYPT Utility
SYNOPSIS: ocrypt [-d] password infile outfile
Encrypts or decrypts a file using a password. It uses a robust, salt-based key derivation function to protect against simple attacks.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that ocrypt cannot corrupt system state or bypass security boundaries.
xor : XOR Utility
SYNOPSIS: xor KEY [FILE]
Encrypts or decrypts the given FILE or standard input using a repeating XOR cipher with the provided KEY. The command is its own inverse; running it a second time with the same key will decrypt the content. This is a simple cipher and should not be used for serious security.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that xor cannot corrupt system state or bypass security boundaries.
zip : ZIP Utility
SYNOPSIS: zip archive.zip file...
zip is a compression and file packaging utility. It puts one or more files into a single zip archive. Directories are archived recursively. The resulting archive is base64-encoded to be stored as a text file.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that zip cannot corrupt system state or bypass security boundaries.
unzip : UNZIP Utility
SYNOPSIS: unzip archive.zip [destination_dir]
The unzip utility will extract files from a ZIP archive created by the 'zip' command. If a destination directory is specified, files will be extracted there; otherwise, they are extracted to the current directory.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that unzip cannot corrupt system state or bypass security boundaries.
fsck : FSCK Utility
SYNOPSIS: fsck [--repair]
fsck is used to check and optionally repair the virtual file system. It checks for orphaned nodes (files owned by non-existent users/groups), dangling symbolic links, and ensures every user has a home directory.
Options & Flags:
--repairAttempt to repair any issues found. Orphaned nodes will be reassigned to root, and dangling links will be removed.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that fsck cannot corrupt system state or bypass security boundaries.
🔢 Math & Calculation (2 Commands)
Arbitrary-precision arithmetic, expression evaluation, and algebraic utilities directly inside the shell pipeline.
| Command | Synopsis | Summary |
|---|---|---|
| bc | bc [expression] |
bc is a basic calculator that evaluates a mathematical expression provided as an argument or from standard input |
| expr | expr EXPRESSION |
Print the value of EXPRESSION to standard output |
bc : BC Utility
SYNOPSIS: bc [expression]
bc is a basic calculator that evaluates a mathematical expression provided as an argument or from standard input. It supports basic arithmetic operations (+, -, *, /) and parentheses for grouping. It also supports several mathematical functions like sqrt(), pow(), sin(), etc.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. bc operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
expr : EXPR Utility
SYNOPSIS: expr EXPRESSION
Print the value of EXPRESSION to standard output. Supports basic arithmetic operators: +, -, *, /, % and parentheses for grouping. Each part of the expression must be separated by spaces.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. expr operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
🕰️ Versioning & System State (6 Commands)
Snapshot-based time travel versioning (.story/), manual storage synchronization, system image backups, restores, and factory resets.
| Command | Synopsis | Summary |
|---|---|---|
| story | story <sub-command> [options] |
Manages the history of a project as a series of named "chapters" (snapshots) |
| sync | sync |
The sync utility forces a write of all buffered file system data |
| backup | backup |
Creates a JSON file containing a snapshot of the current system state, |
| restore | restore |
Restores the FractalOS system from a backup file ( |
| reset | reset |
The reset command completely wipes all system data from the browser, |
| reboot | reboot |
Stops all running processes and restarts the FractalOS session by |
story : STORY Utility
SYNOPSIS: story <sub-command> [options]
Manages the history of a project as a series of named "chapters" (snapshots). It's designed to be simple, safe, and intuitive.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Snapshot Tree Traversal: Traverses
.story/content-addressed blobs, updating commit manifests or rolling back VFS inodes. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the story command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
sync : SYNC Utility
SYNOPSIS: sync
The sync utility forces a write of all buffered file system data to the underlying persistent storage (IndexedDB in the browser). It is useful to ensure all changes are saved before a critical operation.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that sync cannot corrupt system state or bypass security boundaries.
backup : BACKUP Utility
SYNOPSIS: backup
Creates a JSON file containing a snapshot of the current system state, including the filesystem, users, groups, and session data. The backup includes a checksum for integrity verification. This command can only be run by the 'root' user.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
backup_data) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the backup command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
restore : RESTORE Utility
SYNOPSIS: restore
Restores the FractalOS system from a backup file (.json). This operation is destructive and will overwrite your entire current system. The command will prompt you to select a backup file and confirm before proceeding. This command can only be run by the root user.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
trigger_restore_flow) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the restore command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
reset : RESET Utility
SYNOPSIS: reset
The reset command completely wipes all system data from the browser, including the filesystem, user accounts, and all session data, restoring it to the default, initial state. This is a destructive factory reset operation and requires confirmation. This command can only be run by the root user.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
confirm,full_reset) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the reset command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
reboot : REBOOT Utility
SYNOPSIS: reboot
Stops all running processes and restarts the FractalOS session by reloading the page.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
reboot) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the reboot command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
📢 System Communication & Ambiance (10 Commands)
Inter-process message queuing, system bulletin boards, notification banners, host clipboard sync, and cinematic visual styling.
| Command | Synopsis | Summary |
|---|---|---|
| bulletin | bulletin <sub-command> [options] |
Manages the system-wide, persistent message board located at /var/log/bulletin |
| post_message | post_message <job_id> "<message>" |
Sends a string <message> to the specified <job_id>'s message queue |
| read_messages | read_messages <job_id> |
Retrieves all pending string messages for the specified <job_id> |
| notify | notify <message> [--info|--success|--warn|--error] [--silent]
notify list
notify clear |
Sends a notification alert to the FractalOS persistent status bar |
| clip | clip [copy <text> | paste | clear | status]
clip [-c | -p | -x | -s]
<command> | clip |
Interacts with the system clipboard |
| pbcopy | pbcopy [text...]
<command> | pbcopy |
Copies data from standard input or command arguments to the system clipboard, |
| pbpaste | pbpaste |
Outputs the contents of the system clipboard to standard output, |
| theme | theme [list|apply <theme_name>|get <theme_name>] |
Allows users to list, apply, or retrieve data for themes |
| cinematic | cinematic [on|off] |
Engages or disengages a cinematic mode where all terminal output is |
| ritual | ritual <name> |
A ritual is a performative act that prepares the system and the magician for magical workings |
bulletin : BULLETIN Utility
SYNOPSIS: bulletin <sub-command> [options]
Manages the system-wide, persistent message board located at /var/log/bulletin.md. Any user can post a message or list the contents, but only the root user can clear the board. Users in the 'towncrier' group can make official announcements.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that bulletin cannot corrupt system state or bypass security boundaries.
post_message : POST_MESSAGE Utility
SYNOPSIS: post_message <job_id> "<message>"
Sends a string <message> to the specified <job_id>'s message queue for inter-process communication.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
post_message) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the post_message command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
read_messages : READ_MESSAGES Utility
SYNOPSIS: read_messages <job_id>
Retrieves all pending string messages for the specified <job_id>. Once read, messages are removed from the queue. The output is a space-separated string of all messages.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
read_messages) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the read_messages command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
notify : NOTIFY Utility
SYNOPSIS: notify <message> [--info|--success|--warn|--error] [--silent]
notify list
notify clear
Sends a notification alert to the FractalOS persistent status bar ticker and archives it into the system notification drawer.
Options & Flags:
--infoInformation notification (default, blue).--successSuccess notification (green checkmark).--warnWarning notification (yellow alert).--errorError alert (red critical badge).
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
notify,status_action) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the notify command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
clip : CLIP Utility
SYNOPSIS: clip [copy <text> | paste | clear | status]
clip [-c | -p | -x | -s]
<command> | clip
Interacts with the system clipboard. Allows copying text to clipboard, pasting from clipboard, checking status, and piping shell output into clipboard.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
clipboard_action) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the clip command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
pbcopy : PBCOPY Utility
SYNOPSIS: pbcopy [text...]
<command> | pbcopy
Copies data from standard input or command arguments to the system clipboard, matching macOS / BSD pbcopy behavior.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
clipboard_action) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the pbcopy command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
pbpaste : PBPASTE Utility
SYNOPSIS: pbpaste
Outputs the contents of the system clipboard to standard output, matching macOS / BSD pbpaste behavior.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
clipboard_action) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the pbpaste command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
theme : THEME Utility
SYNOPSIS: theme [list|apply <theme_name>|get <theme_name>]
Allows users to list, apply, or retrieve data for themes. Themes are stored as .json files in /etc/themes/.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
apply_theme) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the theme command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
cinematic : CINEMATIC Utility
SYNOPSIS: cinematic [on|off]
Engages or disengages a cinematic mode where all terminal output is displayed character by character, creating a dramatic, retro effect. Running the command without an argument toggles the current state.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
toggle_cinematic_mode) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the cinematic command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
ritual : RITUAL Utility
SYNOPSIS: ritual <name>
A ritual is a performative act that prepares the system and the magician for magical workings. It is not one action, but a sequence of commands, sounds, and delays designed to create a sympathetic environment for the intended spellcraft. It turns mere execution into a deliberate act of will.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
execute_commands) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the ritual command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🎵 Audio & Screen Capture (3 Commands)
Tone.js polyphonic sound generation, system auditory beeps, and browser canvas terminal screen captures.
| Command | Synopsis | Summary |
|---|---|---|
| play | play "<note or chord>" <duration> |
Plays a musical note or chord using the system synthesizer |
| beep | beep |
Plays a short, simple system tone through the emulated sound card |
| printscreen | printscreen [output_file] |
The printscreen command captures the visible content of the terminal |
play : PLAY Utility
SYNOPSIS: play "<note or chord>" <duration>
Plays a musical note or chord using the system synthesizer. Notes should be specified in standard notation (e.g., C4, F#5). Chords are space-separated notes within quotes. Duration is specified in notation like '4n' (quarter note) or '8n' (eighth note).
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
play_sound) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the play command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
beep : BEEP Utility
SYNOPSIS: beep
Plays a short, simple system tone through the emulated sound card. It's useful for getting auditory feedback in scripts or to signal the completion of a task.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
beep) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the beep command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
printscreen : PRINTSCREEN Utility
SYNOPSIS: printscreen [output_file]
The printscreen command captures the visible content of the terminal. In Image Mode (default), it generates a PNG image of the terminal and initiates a browser download. In Text Dump Mode, if an [output_file] is specified, it dumps the visible text content of the terminal to that file.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
capture_screenshot_png,dump_screen_text) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the printscreen command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
💾 Host I/O & File Transfer (2 Commands)
Bridging files between the host machine's physical storage and the virtual filesystem via browser download anchors and file picker dialogs.
| Command | Synopsis | Summary |
|---|---|---|
| upload | upload |
Initiates a file upload from your local computer to the current directory |
| export | export <file> |
Initiates a browser download for the specified FILE, allowing you to save it from the virtual file system to your computer's local hard drive |
upload : UPLOAD Utility
SYNOPSIS: upload
Initiates a file upload from your local computer to the current directory in FractalOS by opening the browser's native file selection dialog. You can select multiple files to upload at once.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
trigger_upload_flow) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the upload command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
export : EXPORT Utility
SYNOPSIS: export <file>
Initiates a browser download for the specified FILE, allowing you to save it from the virtual file system to your computer's local hard drive.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
export_file) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the export command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🚀 Applications, Runtimes & Hardware (8 Commands)
Full-screen integrated applications, language interpreters (CPython 3.14, BASIC), package management, and Raspberry Pi GPIO automation.
| Command | Synopsis | Summary |
|---|---|---|
| edit | edit [filepath] [--dock|-d] [--float|-f] [--full] |
Launches the FractalOS graphical text editor |
| paint | paint [filename.oopic] |
Launches a character-based art editor |
| adventure | adventure [path_to_game.json]
adventure --create [filename.json] |
Launches the FractalOS interactive fiction engine |
| basic | basic [filename.bas] |
Launches a full-screen IDE for Fractal Basic |
| log | log [-n "entry text"] |
The 'log' command serves as your personal, timestamped journal |
| python | python [options] [arguments] |
Executes the python utility |
| pkg | pkg list [-j|--json]
pkg init <name> [target_file.py]
pkg validate <path|name> [-j|--json]
pkg pack <path> [-o <out.fpkg>] [-j|--json]
pkg publish <path|name> [-n|--dry-run] [-e <dir>] [-r <url>] [-m|--mesh]
pkg search [query]
pkg deps <name|file.py> [-j|--json]
pkg install <name|url|path> [--no-deps] [--skip-verify] [-t|--trust]
pkg remove <name> [-f|--force]
pkg verify [name] [-j|--json]
pkg audit [name|file] [-j|--json] |
Manages, validates, bundles, publishes, resolves dependencies, and installs |
| gpio | gpio mode <pin> <in|out>
gpio read <pin>
gpio write <pin> <0|1>
gpio monitor <pin> [--trigger <change|rising|falling>] [--interval <ms>] [--action <cmd>] [--mesh]
gpio stop <pin>
gpio monitors
gpio simulate <pin> <0|1>
gpio stream <pin> [count] |
Interacts with hardware sensors, buttons, and actuators |
edit : EDIT Utility
SYNOPSIS: edit [filepath] [--dock|-d] [--float|-f] [--full]
Launches the FractalOS graphical text editor. - If a filepath is provided, it opens that file. - If the file does not exist, a new empty file will be created with that name upon saving. - If no filepath is given, it opens a new, untitled document.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the edit command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
paint : PAINT Utility
SYNOPSIS: paint [filename.oopic]
Launches a character-based art editor. If a filename is provided, it will be opened. Files must have the '.oopic' extension.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the paint command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
adventure : ADVENTURE Utility
SYNOPSIS: adventure [path_to_game.json]
adventure --create [filename.json]
Launches the FractalOS interactive fiction engine. When run without arguments, it starts the default built-in adventure. If a path to a valid JSON game file is provided, it will load that adventure instead.
Options & Flags:
--createLaunches the interactive adventure creation tool to build a new game file.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app,launch_interactive_app) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the adventure command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
basic : BASIC Utility
SYNOPSIS: basic [filename.bas]
Launches a full-screen IDE for Fractal Basic. If a filename is provided, that file will be loaded into the editor buffer.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the basic command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
log : LOG Utility
SYNOPSIS: log [-n "entry text"]
The 'log' command serves as your personal, timestamped journal. - Quick Add Mode: Running 'log' with the -n flag creates a new entry. - Application Mode: Running 'log' with no arguments launches the graphical app.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the log command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
python : PYTHON Utility
SYNOPSIS: python [options] [arguments]
Executes the python utility.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that python cannot corrupt system state or bypass security boundaries.
pkg : PKG Utility
SYNOPSIS: pkg list [-j|--json]
pkg init <name> [target_file.py]
pkg validate <path|name> [-j|--json]
pkg pack <path> [-o <out.fpkg>] [-j|--json]
pkg publish <path|name> [-n|--dry-run] [-e <dir>] [-r <url>] [-m|--mesh]
pkg search [query]
pkg deps <name|file.py> [-j|--json]
pkg install <name|url|path> [--no-deps] [--skip-verify] [-t|--trust]
pkg remove <name> [-f|--force]
pkg verify [name] [-j|--json]
pkg audit [name|file] [-j|--json]
Manages, validates, bundles, publishes, resolves dependencies, and installs community packages in FractalOS with integrity verification and security sandboxing. Packages are Python files defining the command interface: - metadata(): returns dict with name, version, description, author, license, wheels, dependencies, permissions - define_flags(): declares command line flags and aliases - run(args, flags, user_context, ...): execution entry point - man(...) and help(...): documentation
Options & Flags:
-n, --dry-runSimulate packaging/publishing and preview the catalog entry without modifying files.-j, --jsonOutput manifest, validation, dependency tree, audit report, or package bundle in JSON format.-e, --export <dir>Specify custom export directory for package publishing.-o, --out <file>Specify output destination file for 'pkg pack'.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Package Lifecycle Management: Performs SHA256 integrity checks, inspects permission scopes, and manages package nodes in
/etc/packages/. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the pkg command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
gpio : GPIO Utility
SYNOPSIS: gpio mode <pin> <in|out>
gpio read <pin>
gpio write <pin> <0|1>
gpio monitor <pin> [--trigger <change|rising|falling>] [--interval <ms>] [--action <cmd>] [--mesh]
gpio stop <pin>
gpio monitors
gpio simulate <pin> <0|1>
gpio stream <pin> [count]
Interacts with hardware sensors, buttons, and actuators. In Portable Mode on a Raspberry Pi, communicates with physical hardware via Neutralino's OS bridge. In browser or virtual mode, provides a virtual bus with full sensor simulation and background monitoring.
Options & Flags:
--trigger, -tTrigger condition for monitoring: 'change' (default), 'rising' (button press / low-to-high),or 'falling' (button release / high-to-low).--interval, -iPolling interval in milliseconds (default: 500ms).--action, -aShell command string executed automatically when trigger condition fires.--mesh, -m
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Mesh Transport Coordination: Checks local peer discovery state and RTC channel readiness before dispatching payloads.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
gpio_monitor_list,gpio_monitor_start,gpio_monitor_stop,gpio_simulate) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the gpio command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🎲 TUI Games & Entertainment (6 Commands)
Built-in interactive games, dice rollers, text adventures, turn-based Connect 4, and networked multiplayer lobbies.
| Command | Synopsis | Summary |
|---|---|---|
| c4 | c4 [peer] [--bot] [--gui]
c4 <1-7>
c4 move <1-7>
c4 board
c4 bot
c4 resign |
Direct shortcut for Connect 4 in FractalOS |
| ttt | ttt [peer] [--bot] [--gui]
ttt <1-9>
ttt move <1-9>
ttt board
ttt bot
ttt resign |
Direct shortcut for Tic-Tac-Toe in FractalOS |
| netgame | netgame list
netgame host <game> [peer] [--gui] [--bot]
netgame accept <peer> [--gui]
netgame move <coordinate>
netgame board
netgame status
netgame bot <game>
netgame play <game>
netgame resign
netgame close |
Runs peer-to-peer multiplayer turn-based terminal games across FractalOS nodes |
| roll | roll <notation> |
Rolls dice based on standard tabletop RPG notation (e |
| score | score |
Displays a leaderboard of users based on the number of tasks they have |
| cast | cast <spell> [options] |
The cast command allows the user to perform magical spells that have tangible effects on the operating system's state |
c4 : C4 Utility
SYNOPSIS: c4 [peer] [--bot] [--gui]
c4 <1-7>
c4 move <1-7>
c4 board
c4 bot
c4 resign
Direct shortcut for Connect 4 in FractalOS. See 'man netgame' for full details.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. c4 operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
ttt : TTT Utility
SYNOPSIS: ttt [peer] [--bot] [--gui]
ttt <1-9>
ttt move <1-9>
ttt board
ttt bot
ttt resign
Direct shortcut for Tic-Tac-Toe in FractalOS. See 'man netgame' for full details.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. ttt operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
netgame : NETGAME Utility
SYNOPSIS: netgame list
netgame host <game> [peer] [--gui] [--bot]
netgame accept <peer> [--gui]
netgame move <coordinate>
netgame board
netgame status
netgame bot <game>
netgame play <game>
netgame resign
netgame close
Runs peer-to-peer multiplayer turn-based terminal games across FractalOS nodes. Supports Connect 4 ('c4') and Tic-Tac-Toe ('ttt'). Can be played directly in shell mode with ANSI-rendered boards or in a graphical fullscreen TUI window. Also supports solo matches against an automated bot.
Options & Flags:
--gui, -gLaunches the game in a graphical TUI window.--bot, -bPlays locally against an automated bot.--localPlays local pass-and-play.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - Workspace State Resolution: Queries active pane or window context to coordinate layout geometry and active terminal viewport mapping.
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app,mesh_game_action) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the netgame command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
roll : ROLL Utility
SYNOPSIS: roll <notation>
Rolls dice based on standard tabletop RPG notation (e.g., XdY+Z). It shows the individual rolls, the modifier, and the final total.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. roll operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
score : SCORE Utility
SYNOPSIS: score
Displays a leaderboard of users based on the number of tasks they have completed using the 'planner' command. It's a fun way to track productivity!
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that score cannot corrupt system state or bypass security boundaries.
cast : CAST Utility
SYNOPSIS: cast <spell> [options]
The cast command allows the user to perform magical spells that have tangible effects on the operating system's state.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
execute_commands) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the cast command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
🧭 System Discovery & Navigation (3 Commands)
Interactive manual page viewer, help index generator, and present working directory interrogation.
| Command | Synopsis | Summary |
|---|---|---|
| help | help [command] |
Displays a list of all available commands |
| man | man [command_name] |
man is the system's manual pager |
| pwd | pwd |
Print the full filename of the current working directory |
help : HELP Utility
SYNOPSIS: help [command]
Displays a list of all available commands. If a command is specified, it displays a short usage summary for that command. For more detailed information, use 'man [command]'.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Follows standard Unix modularity and the single-responsibility principle. help operates cleanly as a composable pipeline component, handling input streams and exit statuses predictably.
man : MAN Utility
SYNOPSIS: man [command_name]
man is the system's manual pager. It formats and displays the on-line manual page for a given command.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - State & Context Preparation: Binds execution context (working directory, environment variables, active user identity).
- Effect Dispatch: Evaluates command operations and constructs declarative effect payload(s) (
launch_app) for frontend fulfillment. - Frontend Fulfillment: Returns JSON result structure containing the declarative effect to
effect_handler.js, triggering browser UI/audio execution.
Employs the Effect Contract Pattern (Decision D-002). By keeping presentation, audio, and DOM manipulation strictly decoupled in the JavaScript stage manager, the man command remains completely deterministic, sandboxed, and headlessly testable in pure Python.
pwd : PWD Utility
SYNOPSIS: pwd
Print the full filename of the current working directory.
Options & Flags:
This command takes no options.
- Input & Flag Parsing: The executor tokenizes arguments, matching defined flags (via
define_flags()if configured) and isolating positional path or string targets. - VFS Path & Permission Validation: Interacts with
filesystem.fs_managerto resolve paths, traverse inodes, and verify POSIX read, write, or execute permissions foruser_context. - In-Memory Computation: Executes core logic synchronously or asynchronously within CPython 3.14 WebAssembly space.
- Output Emission: Formats clean stdout string (with optional ANSI styling when requested) returned to the terminal output buffer.
Leverages centralized VFS authority (Tenet 1: Python is the Source of Truth). Centralizing inode manipulation and octal permission checks within filesystem.py ensures that pwd cannot corrupt system state or bypass security boundaries.