macOS
Homebrewverified · 100%
brew install umlocal Homebrew formula metadata
brew / rank 11907
Install um with Homebrew
Command-line utility for creating and maintaining personal man pages. Version 4.2.0 via Homebrew; verified from local package data.
install
Additional install commands
overview
Package summary
Command-line utility for creating and maintaining personal man pages
Project links
Commands and aliases
- um
history
Project history and usage
um is a command-line utility for creating and maintaining personal man-like help pages.
Project history
The project grew out of the observation that traditional man pages are comprehensive but often too long for recurring personal reference. Its README frames um pages as concise Markdown notes that can be rendered into man-like output, with Kramdown replacing an earlier Pandoc-based conversion path.
Adoption history
The official README documents availability through Homebrew on macOS and Linux, plus Arch Linux AUR packages. The repository's 1.0.0 tag dates to late 2015, giving the tool a long-running but deliberately small CLI footprint.
How it is used
Users run commands such as um edit grep, um grep, um list, um rm, and um topic to maintain small per-topic references for commands, CSS properties, or other repeated lookup material.
Why package nerds care
um is a package-nerd tool in the literal sense: it helps terminal users write their own compact documentation for commands they repeatedly forget, and it ships through Homebrew/AUR channels rather than a large hosted service.
Timeline
- 2015: Official repository tag 1.0.0 is associated with a December 2015 commit.
- README era: Project documents the switch from Pandoc to Kramdown for Markdown-to-man-page rendering.
- README era: Official installation lists Homebrew and Arch AUR packages.
Related projects
- um is related to Unix man pages, roff-style documentation, Markdown note systems, Kramdown, and the broader CLI personal-knowledge workflow.
Sources
security posture
Risk level: green
narrow executable package without higher-risk signals.
Risk classifier
green risk · low confidence · appliance
Why
- narrow executable package without higher-risk signals
Signals
- metadata:no-higher-risk-signals
Install behavior
- No Homebrew post-install hook is recorded in formula metadata.
- Homebrew bottle metadata is available for 6 platform targets.
- Installs with 1 runtime dependencies.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
local files
Configuration and credential file locations
These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.
Configuration files
Config paths the tool may read or write during local use.
- Unix
~/.um/umconfig
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
um | cli | global executable |
freshness
Version and freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
page generated2026-08-04
manager version4.2.0
manager updated
local dataok
upstreamcurrent
latest detected4.2.0
https://github.com/sinclairtarget/um
- infoNo package-manager update timestamp was available.low confidence
install metadata
Package metadata
| Package key | brew:um |
|---|---|
| Version | 4.2.0 |
| Package manager | Homebrew |
| Package manager page | https://formulae.brew.sh/formula/um |
| Homepage | https://github.com/sinclairtarget/um |
| Repository | https://github.com/sinclairtarget/um |
| License | MIT |
| Source archive | https://github.com/sinclairtarget/um/archive/refs/tags/4.2.0.tar.gz |
| Dependencies | ruby |
| Bottle | available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux) |
| Homebrew post-install | not defined |
| Service | none declared |
registry facts
Source database details
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | um |
| Version Scheme | 0 |
| Revision | 0 |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Geiger risk classifier
- cross-ecosystem install command graph
- curated configuration and credential file locations
- curated package history
- package relationship graph
- package version freshness
- package-page enrichment
- pkg.so package database
- pkgdb category and tag curation