Every manual was read against the code, the scripts and the upstream sources, and the samples in docs/cli.md were recaptured under --mock where they had drifted. The one a newcomer would hit first: config.example.toml set default_profile to a COM5 profile. Copied verbatim, as configuration.md says to, it broke every device command on a machine with no COM5. default_profile is commented out now, so the copied file leaves discovery working. default_tx_power goes from both, because nothing reads it. docs/cli.md: config show has 22 settings and preferences show 21, not 20 and 8; monitor's blocks have no blank line between them; the diagnostics sample is labelled as a real-radio example with absolute instants and every table; an unknown key exits 1; devices, role and records describe the values they really produce; no maintainer paths; and the "used to" passages describe the present, since a first-time reader never saw the past. picocalc.md: the Calculinux image carries a build stamp, so the gunzip and dd lines take a wildcard; the front SD slot stays empty on first boot; masking wifi-kick is what stops it, and time-sync is disabled with it; updates run the scripts from the pulled checkout with TMPDIR set; the tested list names only what a test checks; git ships in the base image; a bare meshterm shows the splash, and -p picocalc skips it. uconsole.md: an AIO v2 needs MESHCORE_EN_PINS=27 whichever runtime is installed; the bookworm paragraph states what upstream actually ships; the bridge shares the key but keeps its own contacts and radio settings; the defaults are the US/Canada preset; Step 7 downloads what it installs; updating ends with a restart; no claim of test coverage the suite does not have. terminals.md, features.md, hardware.md, cookbook.md, configuration.md and the scripts READMEs get the smaller corrections their audits found. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
3.0 KiB
MeshTerm documentation
Everything that didn't belong on the front page. The README is the front door — what MeshTerm is, how to install it, and enough to get a first session running. This folder is the rest.
Using MeshTerm
| Read | For |
|---|---|
| What MeshTerm does | Every screen the menu offers, grouped the way the menu groups them, with the command that does the same job without it. |
| The command line | The manual. Every subcommand and option, what each prints on the plain and JSON faces, the exit statuses, and recipes built on jq. |
| The CLI cookbook | Common one-liners by task, for when you want the shape of a command rather than its specification. |
| Configuring MeshTerm | Preferences versus config, device profiles, and everything kept under ~/.meshterm. |
| Terminals, icons, and the Windows console | Why the icons and charts draw on some terminals and not others, and what MeshTerm does about it on Windows. |
Putting it on hardware
Only if you want MeshTerm running on a handheld's own screen. A MeshCore companion on USB, Bluetooth or Wi-Fi needs none of this.
| Read | For |
|---|---|
| MeshTerm on hardware | Start here — which of the two manuals below is yours, and what the device-side scripts do. |
| MeshTerm on the PicoCalc | A stock ClockworkPi PicoCalc to a Linux handheld with a LoRa radio soldered inside: the shopping list, the Lyra swap, Calculinux, and the radio. |
| MeshTerm on the uConsole | A uConsole with the hackergadgets AIO LoRa board, whose SX1262 sits on the host's own SPI bus, fronted as a companion by a small bridge. |
Reading the code
| Read | For |
|---|---|
| How the code is laid out | The layering, and where a new feature goes. |
| CLAUDE.md | The actual style guide — terminology, UX standards, and the reusable building blocks. Written for AI assistants, and the house rules for everyone. |
| CONTRIBUTING.md | The dev install, the three gates a change has to pass, and what happens to your contribution's licensing. |
Historical record
Two surveys of the code, written the same day against the same commit. They are kept because a project that writes down its own problems is easier to trust than one that doesn't — but they are snapshots of a date, not to-do lists. Some of what they describe has been fixed since. The navigation survey marks what was resolved; the UI survey does not.
| Read | For |
|---|---|
| Navigation survey | Every exception to "Esc pops the stack", catalogued. |
| UI consistency survey | Everything else in the CLAUDE.md UX standard — six sweeps found nothing, which is the useful part. |
Also here
screenshots/ holds the captures the README shows and the ones
meshterm.net builds its landing page from, so a file in there is
referenced from more than one place.