buninu 0.3.0 → 0.4.0

package/apps/bunmsh/help/alias.md

@@ -0,0 +1,22 @@
+## alias
+
+Define or print aliases.
+
+### Usage
+
+```sh
+alias [NAME[=VALUE] ...]
+```
+
+### Example
+
+```sh
+alias ll='builtin lsfancy -l'
+alias ll
+```
+
+Output:
+
+```text
+ll='builtin lsfancy -l'
+```

package/apps/bunmsh/help/basename.md

@@ -0,0 +1,38 @@
+## basename
+
+Remove directory components and an optional suffix.
+
+### Usage
+
+```sh
+basename [--] STRING [SUFFIX]
+```
+
+### Options and forms
+
+- `--`: Stop option parsing, allowing a string beginning with `-`.
+- `SUFFIX`: Remove this exact suffix when it is present and is not the whole basename.
+
+### Example
+
+```sh
+basename /usr/local/bin/bun
+```
+
+Output:
+
+```text
+bun
+```
+
+Suffix example:
+
+```sh
+basename archive.tar.gz .gz
+```
+
+Output:
+
+```text
+archive.tar
+```

package/apps/bunmsh/help/builtin.md

@@ -0,0 +1,25 @@
+## builtin
+
+Run a registered builtin explicitly; with no command, list builtin names.
+
+### Usage
+
+```sh
+builtin [--] [COMMAND [ARG ...]]
+```
+
+### Options and forms
+
+- `--`: Stop builtin's own option parsing before the command name.
+
+### Example
+
+```sh
+builtin echo hello
+```
+
+Output:
+
+```text
+hello
+```

package/apps/bunmsh/help/bun.md

@@ -0,0 +1,27 @@
+## bun
+
+Invoke the active Bun runtime.
+
+### Usage
+
+```sh
+bun [ARG ...]
+```
+
+### Options and forms
+
+All arguments are forwarded unchanged to the active Bun runtime. Bun's
+supported flags depend on that runtime version; run the external `bun --help`
+when its own complete CLI reference is required.
+
+### Example
+
+```sh
+bun --version
+```
+
+Output:
+
+```text
+1.4.0
+```

package/apps/bunmsh/help/bunmsh.md

@@ -0,0 +1,47 @@
+## bunmsh
+
+Invoke the active bunmsh entry point.
+
+### Usage
+
+```sh
+bunmsh [ARG ...]
+```
+
+### Options and forms
+
+- `SCRIPT [ARG ...]`: Execute a shell script file.
+- `-c SOURCE [ARG ...]`: Parse and execute shell source text.
+- `-cc COMMAND [ARG ...]`: Execute argv directly without shell parsing or expansion.
+- `-i`: Enter interactive mode after any requested command or script.
+- `--mouse`: Enable terminal mouse events.
+- `--builtin-only`: Disable PATH lookup while retaining builtins.
+- `-V`, `--version`: Print the bunmsh version.
+- `--readme`: Render the bundled README.
+- `--changelog`: Render the bundled changelog.
+- `--build-exe`: Build `./bmsh` for the current platform.
+- `--build-for TARGET`: Cross-compile `./bmsh` for a target.
+- `--`: Stop option parsing before a script path.
+
+### Tar-backend asset controls
+
+These options currently work only with the tar asset backend. They are not
+available to builds that embed the asset directory directly with Bun's
+`--asset` backend. See [single-exe/README.md](../single-exe/README.md) for the
+backend comparison, build setup, and extraction layout.
+
+- `--assets-list`: List embedded asset paths and exit.
+- `--assets-extract`: Extract embedded assets beside the executable and exit.
+- `--assets-external`: Ignore embedded assets and read the extracted files.
+
+### Example
+
+```sh
+bunmsh -c 'echo hello'
+```
+
+Output:
+
+```text
+hello
+```

package/apps/bunmsh/help/cat.md

@@ -0,0 +1,31 @@
+## cat
+
+Concatenate files or stdin.
+
+### Usage
+
+```sh
+cat [--exclude PATTERN]... [--] [FILE ...]
+```
+
+### Options and forms
+
+- `--`: Stop option parsing.
+- `--exclude PATTERN`/`--exclude=PATTERN`: Omit matching file operands using
+  `Bun.Glob` patterns. Repeat the option to exclude more patterns; quote a
+  pattern to prevent the shell from expanding it first.
+- `-`: Read from stdin at that operand position. No other options are supported.
+
+### Example
+
+```sh
+printf 'alpha\n' > alpha.txt
+printf 'beta\n' > beta.txt
+builtin cat --exclude 'alpha.*' *.txt
+```
+
+Output:
+
+```text
+beta
+```

package/apps/bunmsh/help/catfancy.md

@@ -0,0 +1,35 @@
+## catfancy
+
+Render Markdown and colorized parsed structured data; pass other formats through.
+
+### Usage
+
+```sh
+catfancy [--exclude PATTERN]... [--] [FILE ...]
+```
+
+### Options and forms
+
+- `--`: Stop option parsing.
+- `--exclude PATTERN`/`--exclude=PATTERN`: Omit matching file operands using
+  `Bun.Glob` patterns. Repeat the option to exclude more patterns; quote a
+  pattern to prevent the shell from expanding it first.
+- `-`: Read unformatted stdin; file previews are selected from filename extensions.
+- `.js`/`.mjs`/`.cjs`/`.jsx` and `.ts`/`.mts`/`.cts`/`.tsx` files are wrapped
+  in a fenced ` ```javascript `/` ```typescript ` block and rendered through
+  `Bun.markdown.ansi`, for the same syntax coloring Markdown code blocks get.
+
+### Example
+
+```sh
+builtin catfancy package.json
+```
+
+Output:
+
+```text
+{
+  "name": "bunmsh",
+  "version": "0.1.10"
+}  # colorized
+```

package/apps/bunmsh/help/cd.md

@@ -0,0 +1,22 @@
+## cd
+
+Change directory; cd - returns to the previous directory.
+
+### Usage
+
+```sh
+cd [DIRECTORY]
+```
+
+### Example
+
+```sh
+cd /tmp
+pwd
+```
+
+Output:
+
+```text
+/tmp
+```

package/apps/bunmsh/help/chmod.md

@@ -0,0 +1,27 @@
+## chmod
+
+Change modes using octal values, +x, or a+x.
+
+### Usage
+
+```sh
+chmod MODE FILE ...
+```
+
+### Options and forms
+
+- Octal modes such as `755` set all permission bits.
+- `+x` and `a+x` add executable bits.
+
+### Example
+
+```sh
+chmod +x script.sh
+builtin test -x script.sh; echo $?
+```
+
+Output:
+
+```text
+0
+```

package/apps/bunmsh/help/clear.md

@@ -0,0 +1,21 @@
+## clear
+
+Clear the terminal.
+
+### Usage
+
+```sh
+clear
+```
+
+### Example
+
+```sh
+clear
+```
+
+Output:
+
+```text
+(terminal screen is cleared)
+```

package/apps/bunmsh/help/colon.md

@@ -0,0 +1,22 @@
+## :
+
+Do nothing and return success.
+
+### Usage
+
+```sh
+: [ARG ...]
+```
+
+### Example
+
+```sh
+: ignored
+echo $?
+```
+
+Output:
+
+```text
+0
+```

package/apps/bunmsh/help/command.md

@@ -0,0 +1,27 @@
+## command
+
+Run or inspect a command while bypassing aliases.
+
+### Usage
+
+```sh
+command [-pVv] COMMAND [ARG ...]
+```
+
+### Options and forms
+
+- `-p`: Use bunmsh's default command PATH.
+- `-v`: Print a concise lookup result.
+- `-V`: Print a verbose lookup description.
+
+### Example
+
+```sh
+command -V echo
+```
+
+Output:
+
+```text
+echo is a shell builtin
+```

package/apps/bunmsh/help/cp.md

@@ -0,0 +1,28 @@
+## cp
+
+Copy files and directories.
+
+### Usage
+
+```sh
+cp [-rRv] SOURCE ... DESTINATION
+```
+
+### Options and forms
+
+- `-r`, `-R`: Copy directories recursively (`-r` is translated to Bun Shell's `-R`).
+- `-v`: Request verbose output.
+- `-n`: Accepted by Bun Shell but currently does not prevent overwriting.
+
+### Example
+
+```sh
+cp source.txt copy.txt
+cat copy.txt
+```
+
+Output:
+
+```text
+hello
+```

package/apps/bunmsh/help/cut.md

@@ -0,0 +1,25 @@
+## cut
+
+Select character positions.
+
+### Usage
+
+```sh
+cut -c LIST [FILE ...]
+```
+
+### Options and forms
+
+- `-c LIST`, `-cLIST`: Select character positions or ranges such as `1-3,7`.
+
+### Example
+
+```sh
+printf 'abcdef\n' | cut -c2-4
+```
+
+Output:
+
+```text
+bcd
+```

package/apps/bunmsh/help/date.md

@@ -0,0 +1,25 @@
+## date
+
+Print the current date.
+
+### Usage
+
+```sh
+date [+FORMAT]
+```
+
+### Options and forms
+
+- Formats include `%Y` year, `%m` month, `%d` day, `%H` hour, `%M` minute, `%S` second, `%s` Unix time, `%F` date, `%T` time, and `%%` percent.
+
+### Example
+
+```sh
+date +%F
+```
+
+Output:
+
+```text
+2026-08-28
+```

package/apps/bunmsh/help/dirname.md

@@ -0,0 +1,25 @@
+## dirname
+
+Print a path's directory component.
+
+### Usage
+
+```sh
+dirname [--] STRING
+```
+
+### Options and forms
+
+- `--`: Stop option parsing, allowing a string beginning with `-`.
+
+### Example
+
+```sh
+dirname /usr/local/bin/bun
+```
+
+Output:
+
+```text
+/usr/local/bin
+```

package/apps/bunmsh/help/echo.md

@@ -0,0 +1,25 @@
+## echo
+
+Write space-separated arguments.
+
+### Usage
+
+```sh
+echo [-n] [ARG ...]
+```
+
+### Options and forms
+
+- `-n`: Omit the trailing newline.
+
+### Example
+
+```sh
+echo hello world
+```
+
+Output:
+
+```text
+hello world
+```

package/apps/bunmsh/help/env.md

@@ -0,0 +1,27 @@
+## env
+
+Print or modify the environment and optionally run a command.
+
+### Usage
+
+```sh
+env [-i] [-u NAME] [NAME=VALUE ...] [COMMAND [ARG ...]]
+```
+
+### Options and forms
+
+- `-i`, `--ignore-environment`: Start with an empty environment.
+- `-u NAME`, `--unset NAME`, `--unset=NAME`: Remove a variable.
+- `--`: Stop option parsing.
+
+### Example
+
+```sh
+env NAME=value sh -c 'echo "$NAME"'
+```
+
+Output:
+
+```text
+value
+```

package/apps/bunmsh/help/eval.md

@@ -0,0 +1,22 @@
+## eval
+
+Evaluate arguments as shell source.
+
+### Usage
+
+```sh
+eval [ARG ...]
+```
+
+### Example
+
+```sh
+code='echo evaluated'
+eval "$code"
+```
+
+Output:
+
+```text
+evaluated
+```

package/apps/bunmsh/help/exec.md

@@ -0,0 +1,22 @@
+## exec
+
+Run a command and terminate the current shell with its status.
+
+### Usage
+
+```sh
+exec COMMAND [ARG ...]
+```
+
+### Example
+
+```sh
+exec printf 'done\n'
+```
+
+Output:
+
+```text
+done
+(shell exits with status 0)
+```

package/apps/bunmsh/help/exit.md

@@ -0,0 +1,21 @@
+## exit
+
+Exit the current shell.
+
+### Usage
+
+```sh
+exit [STATUS]
+```
+
+### Example
+
+```sh
+exit 7
+```
+
+Output:
+
+```text
+(shell exits with status 7)
+```

package/apps/bunmsh/help/export.md

@@ -0,0 +1,22 @@
+## export
+
+Set or list environment variables.
+
+### Usage
+
+```sh
+export [NAME[=VALUE] ...]
+```
+
+### Example
+
+```sh
+export NAME=value
+env | grep '^NAME='
+```
+
+Output:
+
+```text
+NAME=value
+```

package/apps/bunmsh/help/false.md

@@ -0,0 +1,22 @@
+## false
+
+Return failure.
+
+### Usage
+
+```sh
+false
+```
+
+### Example
+
+```sh
+false
+echo $?
+```
+
+Output:
+
+```text
+1
+```

package/apps/bunmsh/help/find.md

@@ -0,0 +1,33 @@
+## find
+
+Walk paths with name, path, type, depth, print, and -exec expressions.
+
+### Usage
+
+```sh
+find [PATH ...] [EXPRESSION]
+```
+
+### Options and forms
+
+- `-name`, `-iname`: Match a basename, optionally ignoring case.
+- `-path`, `-ipath`: Match a path, optionally ignoring case.
+- `-type f|d|l`: Select files, directories, or links.
+- `-mindepth N`, `-maxdepth N`: Limit traversal depth.
+- `-print`, `-print0`: Emit newline- or NUL-delimited paths.
+- `!`, `-not`: Negate the following expression.
+- `-exec COMMAND {} \;`: Run once per path.
+- `-exec COMMAND {} +`: Run with batches of paths.
+
+### Example
+
+```sh
+find . -type f -name '*.md'
+```
+
+Output:
+
+```text
+./README.md
+./CHANGELOG.md
+```

package/apps/bunmsh/help/getopts.md

@@ -0,0 +1,28 @@
+## getopts
+
+Parse positional options.
+
+### Usage
+
+```sh
+getopts OPTSTRING NAME [ARG ...]
+```
+
+### Options and forms
+
+- A leading `:` in OPTSTRING selects silent error reporting.
+- A letter followed by `:` requires an argument. Results use the named variable plus `OPTARG` and `OPTIND`.
+
+### Example
+
+```sh
+set -- -a value
+getopts a: option
+echo "$option=$OPTARG"
+```
+
+Output:
+
+```text
+a=value
+```