# 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

```sh
sudo av install brew:um
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install um
```

  Evidence: local Homebrew formula metadata

## Package facts

- **Package key:** brew:um
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/um>
- **Version:** 4.2.0
- **Source summary:** Command-line utility for creating and maintaining personal man pages
- **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>
- **Generated:** 2026-08-04T22:13:35+00:00

## Executables

- um (cli)
- um (alias)

## Dependencies

- ruby

## Install behavior

- Post-install hook: not defined
- Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## Freshness

- Page generated: 2026-08-04
- Package-manager version: 4.2.0
- Local data: ok
- Upstream repository: https://github.com/sinclairtarget/um
- Upstream latest detected: 4.2.0 (current)
- info: No package-manager update timestamp was available.
## 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

- <https://api.github.com/repos/sinclairtarget/um/tags?per_page=100>
- <https://raw.githubusercontent.com/sinclairtarget/um/master/README.md>


## Security Notes

narrow executable package without higher-risk signals.

- **Geiger risk:** green / low
- narrow executable package without higher-risk signals


## 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

- Unix: ~/.um/umconfig
## 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:** stable


## Related links

- [Source-control packages](https://pkg.so/source-control-tools/) - Belongs to a source-control command family.
- [Terminal utility packages](https://pkg.so/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Networking and protocol packages](https://pkg.so/networking-protocol-tools/) - Matched network, protocol, or remote-service metadata.
- [Documentation packages](https://pkg.so/documentation-tools/) - Matched documentation, manual, or publishing metadata.
- [ruby](https://pkg.so/brew/ruby/) - Runtime dependency declared by Homebrew.
- [qman](https://pkg.so/brew/qman/) - Shares pkgdb curated category or tags: cli, documentation, man-pages, productivity.
- [cherrytree](https://pkg.so/brew/cherrytree/) - Shares pkgdb curated category or tags: cli, notes, productivity.
- [nb](https://pkg.so/brew/nb/) - Shares pkgdb curated category or tags: cli, notes, productivity.
- [evernote-backup](https://pkg.so/brew/evernote-backup/) - Shares pkgdb curated category or tags: cli, notes, productivity.
- [joplin-cli](https://pkg.so/brew/joplin-cli/) - Shares pkgdb curated category or tags: cli, notes, productivity.
- [jrnl](https://pkg.so/brew/jrnl/) - Shares pkgdb curated category or tags: cli, notes, productivity.
- [mark](https://pkg.so/brew/mark/) - Shares pkgdb curated category or tags: cli, documentation, productivity.
- [zim](https://pkg.so/brew/zim/) - Shares pkgdb curated category or tags: cli, notes, productivity.
- [taskline](https://pkg.so/brew/taskline/) - Local package facts share a topical domain. Shared terms: cli, command-line, line, notes, productivity.
- [adr-tools](https://pkg.so/npm/adr-tools/) - Local metadata places this package in an adjacent workflow. Shared terms: cli, command-line, documentation, line, productivity.

## Combined YAML source

View the package source record on GitHub. [combined/um.yml](https://github.com/mxcl/pkgdb/blob/main/combined/um.yml)


## Sources

- pkg.so package database
- Geiger risk classifier
- package-page enrichment
- curated configuration and credential file locations
- curated package history
- package version freshness
- pkgdb category and tag curation
- package relationship graph
- cross-ecosystem install command graph
