Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ For longer narratives, see link:changelog-details/[changelog-details/] (when pre

== Timeline

* 2026-09-29 — Antora: register under shared `tools` component (`about` module); rewrite overview lede for machine-orientation CLI.
* 2026-07-25 — link:changelog-details/2026-07-25%20-%20command%20orientation%20cards.adoc[Command orientation cards] — `about <cmd>`, tip crosslinks to help/info/man.
* 2026-07-24 — link:changelog-details/2026-07-24%20-%20nushell-aware%20output.adoc[Nushell-aware output] — Nu tip sheet, classic-shell nudge, `--format nuon`.
* 2026-07-23 — link:changelog-details/2026-07-23%20-%20initial%20about%20cli.adoc[Initial `about` CLI] — native + Cosmopolitan APE builds, CI release pipeline.
8 changes: 4 additions & 4 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: about
title: about
name: tools
title: Tools
version: ~
start_page: ROOT:index.adoc
start_page: about:index.adoc
nav:
- modules/ROOT/nav.adoc
- modules/about/nav.adoc
2 changes: 1 addition & 1 deletion docs/modules/ROOT/nav.adoc → docs/modules/about/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
* xref:index.adoc[Overview]
* xref:index.adoc[about]
* xref:usage.adoc[Usage]
* xref:nushell.adoc[Nushell]
* xref:build.adoc[Building]
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
= about
:description: Orient yourself — OS, shell, and how to look around.

One command to answer: *what machine is this, and how do I look around?*
:description: Portable CLI for machine orientation — OS, shell, environment, and how to look around.
:page-audience: operators and developers who land on unfamiliar machines
:page-usage-context: reference for building, running, and interpreting output from the `about` CLI
:page-orig-author: OpenShellOrg
:page-last-author: cursor-agent on behalf of amdphreak
:page-last-edited: 2026-09-29

`about` is a portable CLI that prints machine orientation (OS, shell, environment) and a short OS-family cheat sheet for looking around.
Under https://www.nushell.sh/[Nushell], the cheat sheet uses `nu` idioms (`sys`, `$env`, `ls`, …).
Outside Nushell, you still get the full classic tip sheet — plus a nudge to install `nu`.
Nushell is never required; `about` always runs.

== Why

Drop into a random Linux box via `wsl`, SSH, a container, or a teammate's laptop, and the discovery story is a mess: `/etc/os-release` (sometimes), `uname`, `sw_vers`, `systeminfo`, `$SHELL` vs `ps -p $$`, WSL env vars that only exist on good days…

`about` prints the orientation facts first, then a short cheat sheet of the commands that actually help on *this* OS family.

Under https://www.nushell.sh/[Nushell], the cheat sheet switches to structured `nu` idioms (`sys`, `$env`, `ls`, …).
Outside Nushell, you still get the full classic tip sheet — plus a nudge to install `nu`.
Nushell is never required; `about` always runs.

== Quick start

[source,shell]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
= Related Tools
:description: OpenShellOrg tools that pair with about.

* xref:prohelp::index.adoc[prohelp] — progressive help + global `help`
* xref:info::index.adoc[info] — Info TUI (OpenShellOrg)
* xref:nu-require::index.adoc[nu-require] — require / relaunch under Nushell
* xref:prohelp:index.adoc[prohelp] — progressive help + global `help`
* xref:info:index.adoc[info] — Info TUI (OpenShellOrg)
* xref:nu-require:index.adoc[nu-require] — require / relaunch under Nushell
* xref:shell-architecture::index.adoc[shell-architecture] — OpenShellOrg thesis
* xref:shell-architecture::entrypoint-dispatch.adoc[Entrypoint Dispatch] — auto-install + re-exec at the shell boundary
* https://justine.lol/cosmopolitan/[Cosmopolitan Libc] — build-once run-anywhere C
Expand Down
File renamed without changes.
Loading