❯halpme
Open-source CLI  ·  zsh + glow
halpme

Terminal help for your setup.

Document your aliases, workflows, and tool configs in Markdown — then find them instantly, right where you work.

npx skills add halpme-sh/halpme
View on GitHubInstall guide ↓
02 — Why halpme

Built for the setup you actually have.

01

Forgot your own alias?

You wrote it six months ago. It's in your .zshrc somewhere. halpme git finds it in a second.

halpme git
02

Stays in your terminal.

No browser tab, no wiki login, no copy-paste lag. Your guide renders right where you're already working.

halpme brew
03

Your words, not a wiki.

Add a Markdown file, add a section — it shows up in halpme automatically. It's your setup, documented your way.

~/.config/halpme/
03 — How it works

Three steps. Then it just works.

01

Install

Run one command in Claude Code. The skill installs the script, sets up your config directory, and kicks off an AI-assisted session to build your guide from existing dotfiles.

$ npx skills add halpme-sh/halpme
Installing halpme skill...
Setting up ~/.config/halpme...
✓ halpme ready
02

Add your notes

Drop a Markdown file in ~/.config/halpme/. Each file is a topic. Use the annotation convention to set the keyword and description that appear in your guide.

~/.config/halpme/git.md
### Git Workflow
<!-- halpme: git | Daily aliases -->
### Undo a commit
<!-- halpme: git | Undo without losing work -->
`git reset --soft HEAD~1`
03

Find anything

Type halpme to browse your full guide, or halpme <topic> to jump straight to a section. Rendered by glow, right in your terminal.

$ halpme git
git · Daily aliases & undo commands
──────────────────────
Git Workflow
Undo a commit
Stashing
04 — Install

Get started in seconds.

The recommended path uses Claude Code. A manual install is available if you prefer.

Recommended

Claude Code skill

Run the command below inside Claude Code. It installs the script, sets up~/.config/halpme/, and starts an AI-assisted session to build your guide from your existing dotfiles.

$npx skills add halpme-sh/halpme

Don't have Claude Code?Get it free ↗

Manual install

Requires glow and a zsh shell.

terminal
# 1. Install glow (required)
brew install glow

# 2. Download the script
curl -fsSL https://raw.githubusercontent.com/halpme-sh/halpme/main/halpme.zsh \
  -o ~/bin/halpme.zsh
chmod +x ~/bin/halpme.zsh

# 3. Add alias to your shell config
echo 'alias halpme="zsh ~/bin/halpme.zsh"' >> ~/.zshrc

# 4. Copy starter topic files
mkdir -p ~/.config/halpme
for topic in git shell brew; do
  curl -fsSL "https://raw.githubusercontent.com/halpme-sh/halpme/main/guide/$topic.md" \
    -o "$HOME/.config/halpme/$topic.md"
done

Source, issues, and full docs onGitHub ↗