Skip to content

Add io.pilot.tldr — simplified man pages (tlrc 1.13.1) as a native CLI app#82

Merged
Alexgodoroja merged 1 commit into
mainfrom
submit/io.pilot.tldr
Jul 10, 2026
Merged

Add io.pilot.tldr — simplified man pages (tlrc 1.13.1) as a native CLI app#82
Alexgodoroja merged 1 commit into
mainfrom
submit/io.pilot.tldr

Conversation

@Alexgodoroja

Copy link
Copy Markdown
Collaborator

Adds io.pilot.tldr, packaging the official open-source tldr-pages client tlrc v1.13.1 as a native, per-OS/arch app that fronts simplified, community-driven man pages — concise, example-first cheat-sheets for ~7,350+ command-line tools (a dictionary of man pages for almost every CLI an agent uses to build, deploy, and operate software).

Open source & tested. Client tlrc is MIT; the page content is CC-BY-4.0 (© tldr-pages contributors). Every method was exercised end-to-end (see below). The ~3 MiB page catalog auto-downloads on first use and works offline thereafter.

Methods (10 + auto tldr.help)

  • tldr.get — a command's cheat-sheet as clean text
  • tldr.raw — a page as raw Markdown (machine-parseable)
  • tldr.search — first-class full-text search across the whole catalog
  • tldr.list — the directory of every documented command for the platform
  • tldr.info — cache path / age / languages / page count
  • tldr.update — refresh the local page cache
  • tldr.render — render a local tldr-format .md page
  • tldr.exec — verbatim-argv passthrough (--platform, --language, --list-all, --offline, …) + optional stdin
  • tldr.cli_help — the complete command-palette reference (every flag, value, default) as clean text
  • tldr.version — client + spec version

Delivery

  • Four sha-pinned native tarballs (darwin arm64/amd64, linux arm64/amd64) — the upstream tlrc binary plus a thin wrapper that serves the full color-free palette reference for -help.
  • One stable publisher key (ed25519:PWQdFC8oGtlYsGhVtjMcR1CfOKKa0O3TtKtFD8vrD90=), reused for all future updates.

Verification

  • pilot-app verify-submissionVERIFY OK, all 4 platforms build + pass the catalogue gate.
  • macOS socket mode: every method returns correct real data (staged the binary from the artifact registry).
  • Linux fedora:41 microVM: downloaded the linux-arm64 artifact from the registry, sha-verified, and ran the full suite (version, help, get, raw, search, list = 6544 linux pages, multi-word lookup).

…I app

Bundles the official tldr-pages client tlrc v1.13.1 (MIT) as a sha-pinned,
per-OS/arch native app fronting ~7,350+ example-first command cheat-sheets
(pages CC-BY-4.0). Methods: get, raw, search, list, info, update, render,
exec (verbatim-argv passthrough), cli_help, version. Verified on macOS
(socket) and Linux (fedora:41 microVM); all four platforms build and pass
the catalogue gate.
@github-actions

Copy link
Copy Markdown

A/B report — io.pilot.tldr (vanilla vs Pilot)

Equivalent commands run two ways: the vanilla CLI binary vs the Pilot adapter (socket mode). CI runs non-VM commands only (GitHub runners have no KVM). Full HTML report (commands, outputs, timings, adapter-generated help): download from the run artifacts.

Command Vanilla ms Pilot ms Δ Exit match
version 2 7 +5
cli_help 4 6 +2
get_tar 1299 6 -1293
search_compress 8 10 +2

@Alexgodoroja Alexgodoroja merged commit b5a4203 into main Jul 10, 2026
7 checks passed
@Alexgodoroja Alexgodoroja deleted the submit/io.pilot.tldr branch July 10, 2026 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant