MyHelp

MyHelp is a local-first, cross-platform home for the commands and procedures you do not use often enough to memorize.

It keeps help pages as plain Markdown and exposes the same vault through:

• a fast Rust CLI for terminals and remote sessions;
• a Tauri desktop editor with search and live preview;
• a reusable Rust core shared by both interfaces;
• import/export adapters for established cheatsheet formats, starting with tldr/tealdeer.

Important

This repository is an early public scaffold. The storage core, CLI commands, and desktop editor are intentionally small so subsequent work can be driven by focused GitHub issues.

Why another tool?

MyHelp does not aim to replace the mature tools around it:

• tldr pages defines the concise example-oriented Markdown format.
• tealdeer is an excellent terminal renderer and already supports custom pages.
• navi, cheat, and pet are mature interactive command and snippet managers.
• massCode is a broad desktop workspace with a strong Markdown vault.

The narrower gap MyHelp explores is: one portable, local folder with a small CLI and a focused GUI editor, while remaining interoperable with those formats instead of inventing another closed database. See the research notes.

Current scaffold

myhelp
├── crates/myhelp-core    file model, platform paths, list/read/write/search
├── crates/myhelp-cli     list, show, new, edit, search, path
├── src                   React editor and Markdown preview
├── src-tauri             Tauri commands that call myhelp-core
└── docs                  architecture, format, research, roadmap

No page content is uploaded, and the MVP does not execute saved commands.

Development

The repository includes a Nix Flake for Linux development:

direnv allow
pnpm install

cargo test -p myhelp-core -p myhelp-cli
cargo run -p myhelp-cli -- list
pnpm build
pnpm tauri dev

Without direnv, run nix develop first. Native setup for macOS and Windows is documented by the official Tauri prerequisites guide.

The CLI is also exposed as a Nix app on Linux and macOS:

nix run github:hjosugi/myhelp -- list
nix build github:hjosugi/myhelp#myhelp-cli

This packages only the portable CLI. Desktop packaging remains native platform work tracked in GitHub issues.

CLI preview

myhelp list
myhelp new python/new-project --title "New Python project"
myhelp edit python/new-project
myhelp show python/new-project
myhelp search pytest
myhelp path

Set MYHELP_PAGES_DIR or pass --pages-dir to use an existing Markdown vault.

Language workflow starter pack

The repository includes concise new-project and daily-command pages for the language toolchains used to shape the initial product:

cargo run -p myhelp-cli -- \
  --pages-dir examples/language-workflows list
cargo run -p myhelp-cli -- \
  --pages-dir examples/language-workflows show python-new-project

The pack currently covers Python, Go, Rust, Node.js/TypeScript, Java, Lua, Elixir, Gleam, Haskell, Zig, Ruby, Common Lisp, and C/C++. Every page links to the relevant official documentation. The examples are portable defaults; copy and customize them in your own vault rather than coupling the public project to one machine's dotfiles.

File format

MyHelp starts with the tldr custom-page convention:

# New Python project

> Start a reproducible Python project with Nix and uv.

- Create and enter the development environment:

`nix flake lock && direnv allow`

Flat <topic>.page.md files can be consumed directly by tealdeer when its custom page directory points at the vault. Nested topics are a MyHelp organization extension and will use an explicit export mapping. See the format contract.

Official references

• Tauri 2
• Tauri architecture
• tldr page syntax
• tealdeer custom pages
• Rust CLI with clap

Contributing

Read AGENTS.md, CONTRIBUTING.md, and the open GitHub issues before implementing a feature. Each issue is designed to be workable by a contributor or a coding agent without requiring private dotfiles.

License

MIT