# Install yelp-tools with Homebrew, apk, apt, dnf, MacPorts, Nix, pacman, zypper

Tools that help create and edit Mallard or DocBook documentation. Version 42.1 via Homebrew; verified 2026-04-22.

## Install

```sh
sudo av install brew:yelp-tools
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install yelp-tools
```

  Evidence: local Homebrew formula metadata

- MacPorts (94%):

```sh
sudo port install yelp-tools
```

  Evidence: MacPorts ports tree: gnome/yelp-tools/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1

### Linux

- apk (92%):

```sh
sudo apk add yelp-tools
```

  Evidence: Alpine Linux edge package indexes: yelp-tools from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz

- Debian apt (92%):

```sh
sudo apt install yelp-tools
```

  Evidence: Debian stable package indexes: yelp-tools from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz

- dnf (92%):

```sh
sudo dnf install yelp-tools
```

  Evidence: Fedora Rawhide package metadata: yelp-tools from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst

- Nix (92%):

```sh
nix profile install nixpkgs#yelp-tools
```

  Evidence: nixpkgs package indexes: pkgs/by-name/ye/yelp-tools/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

- pacman (92%):

```sh
sudo pacman -S yelp-tools
```

  Evidence: Arch Linux sync databases: yelp-tools from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz

- zypper (92%):

```sh
sudo zypper install yelp-tools
```

  Evidence: openSUSE Tumbleweed package metadata: yelp-tools from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst

## Package facts

- **Package key:** brew:yelp-tools
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/yelp-tools>
- **Version:** 42.1
- **Source summary:** Tools that help create and edit Mallard or DocBook documentation
- **Homepage:** <https://gitlab.gnome.org/GNOME/yelp-tools>
- **Repository:** <https://gitlab.gnome.org/GNOME/yelp-tools>
- **Upstream docs:** <https://wiki.gnome.org/Apps/Yelp/Tools>
- **License:** GPL-2.0-or-later
- **Source archive:** <https://download.gnome.org/sources/yelp-tools/42/yelp-tools-42.1.tar.xz>
- **Last updated:** 2026-04-22T14:19:50Z
- **Generated:** 2026-07-08T07:18:31+00:00

## Executables

- yelp-build (cli)
- yelp-check (cli)
- yelp-new (cli)
- yelp-build (alias)
- yelp-check (alias)
- yelp-new (alias)

## Dependencies

- itstool
- libxml2
- python@3.14
- yelp-xsl

## Build dependencies

- meson
- ninja
- pkgconf

## Uses from macOS

- libxslt

## 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-07-08
- Package-manager version: 42.1
- Package-manager updated: 2026-04-22
- Local data: ok
- Upstream repository: https://gitlab.gnome.org/GNOME/yelp-tools
- info: Release/tag comparison is only available for GitHub repositories.
## Project history and usage

yelp-tools is GNOME's small toolset for creating, checking, managing, and publishing Mallard or DocBook documentation. Its visible commands include `yelp-build`, `yelp-check`, and `yelp-new`, plus build-system integration through `yelp.m4`.

### Project history

Yelp itself is GNOME's help viewer, and the GNOME wiki describes Yelp development as having produced related tools and XSLT modules under the Yelp umbrella. Yelp-tools separated the authoring and build utilities from the viewer so documentation teams could generate and validate help content without launching the application.

The yelp-tools NEWS file begins with a 3.1.1 initial release in 2011. Early 3.x development quickly added Mallard page status checks, EPUB generation, itstool and xmllint checks, faster HTML/cache generation, href validation, stricter validation, and DocBook link support.

The toolset followed GNOME's help-stack evolution: support for Mallard Sites appeared in the 3.17 series, Mallard stack files arrived in the 3.31 series, and the 40.alpha cycle converted `yelp-build`, `yelp-check`, and `yelp-new` to Python while moving to Meson and adding `.yelp-tools.cfg` support.

### Adoption history

Adoption follows GNOME documentation infrastructure. The wiki presents yelp-tools as the package for creating and publishing Mallard or DocBook documentation, and downstream package indexes show it distributed broadly across Linux, BSD, MSYS2, Homebrew, MacPorts, Nix, and other ecosystems.

Because many GNOME and GTK-adjacent projects ship localized help, yelp-tools is more important than its small executable list suggests. It packages the boring but essential checks that keep help pages buildable, linkable, translatable, and publishable.

### How it is used

`yelp-build` creates output such as HTML and EPUB from Mallard or DocBook sources. The GNOME wiki documents HTML generation from page files, directories of Mallard pages, or a top-level DocBook file.

`yelp-check` validates documents, checks links and hrefs, detects orphaned pages, checks media, statuses, page IDs, comments, licenses, and custom checks. `yelp-new` creates new documents and pages from templates, while `yelp.m4` helps integrate help builds into Autotools-era projects.

### Why package nerds care

yelp-tools is package-nerd significant because it is infrastructure for documentation packages, not the documentation itself. It turns GNOME help authoring conventions into repeatable build and validation commands that distributions can rely on.

It is also a good example of a desktop project splitting runtime viewing, XSLT transformation, translation extraction, validation, and templates into separate packages so maintainers can depend on only the build-time pieces they need.

### Timeline

- 2011-05-08: The NEWS file records yelp-tools 3.1.1 as the initial release.
- 2011-05-23: The 3.1.3 line adds Mallard status checking and EPUB building.
- 2012-03-26: The 3.4.0 line adds DocBook support for `yelp-check` links and hrefs commands.
- 2015: The 3.17 series adds Mallard Sites support across yelp-build and yelp-check.
- 2019: The 3.31 series adds initial support for Mallard 1.2 stack files.
- 2021-02-06: The 40.alpha line moves to Meson, converts the main tools to Python, adds improved templates, and introduces `.yelp-tools.cfg`.
- 2022-10-30: The 42.1 tag fixes a DocBook path issue and remains a widely packaged line.

### Related projects

- Related projects include Yelp, yelp-xsl, Mallard, Project Mallard, DocBook, itstool, xmllint, GNOME Help, GNOME Documentation Project workflows, ScrollKeeper/Rarian-era help infrastructure, and Autotools/Meson documentation builds.

### Sources

- <https://archlinux.org/packages/extra/any/yelp-tools/>
- <https://github.com/GNOME/yelp>
- <https://gitlab.gnome.org/GNOME/yelp-tools>
- <https://gitlab.gnome.org/GNOME/yelp-tools/-/raw/master/NEWS>
- <https://gitlab.gnome.org/api/v4/projects/GNOME%2Fyelp-tools>
- <https://gitlab.gnome.org/api/v4/projects/GNOME%2Fyelp-tools/repository/tags?per_page=100&page=1>
- <https://packages.msys2.org/package/yelp-tools>
- <https://wiki.gnome.org/Apps%282f%29Yelp.html>
- <https://wiki.gnome.org/Apps/Yelp/Tools>
- <https://www.freshports.org/textproc/yelp-tools>


## Security Notes

narrow executable package without higher-risk signals.

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

## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** yelp-tools
- **Version Scheme:** 0
- **Revision:** 3
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** stable

## Other Package-Manager Records

- Debian apt - yelp-tools - 42.1-3: normalized package name match | Debian stable package indexes: yelp-tools from https://deb.debian.org/debian/dists/stable/main/binary-amd64/Packages.xz | Yelp documentation tools | https://wiki.gnome.org/Apps/Yelp/Tools
- Nix - yelp-tools: normalized package name match | nixpkgs package indexes: pkgs/by-name/ye/yelp-tools/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
- Ubuntu apt - yelp-tools - 42.1-2: normalized package name match | Ubuntu 24.04 LTS package indexes: yelp-tools from https://archive.ubuntu.com/ubuntu/dists/noble/universe/binary-amd64/Packages.gz | Yelp documentation tools | https://wiki.gnome.org/Apps/Yelp/Tools
- apk - yelp-tools - 42.1-r2: normalized package name match | Alpine Linux edge package indexes: yelp-tools from https://dl-cdn.alpinelinux.org/alpine/edge/community/x86_64/APKINDEX.tar.gz | Collection of utilities to help create documentation | https://gitlab.gnome.org/GNOME/yelp-tools
- dnf - yelp-tools - 42.1-12.fc45: normalized package name match | Fedora Rawhide package metadata: yelp-tools from https://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/Everything/x86_64/os/repodata/e5ca8ce900cd68f5419e1c39ae517343100b306336cbaeb70a3c153121d95094-primary.xml.zst | Create, manage, and publish documentation for Yelp | https://wiki.gnome.org/Apps/Yelp/Tools
- pacman - yelp-tools - 42.1-2: normalized package name match | Arch Linux sync databases: yelp-tools from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz | Collection of tools for building and converting documentation | https://gitlab.gnome.org/GNOME/yelp-tools
- zypper - yelp-tools - 42.1-2.5: normalized package name match | openSUSE Tumbleweed package metadata: yelp-tools from https://download.opensuse.org/tumbleweed/repo/oss/repodata/be8d3611d25469107f32075a1697e69ec57a2b850b42348a658cc671ad5ec2b50760d02c3e59524d50da9a11d5be799bdaffba2e166e8ca8858512e3c0bd665d-primary.xml.zst | Collection of utilities to help create documentation | https://projects.gnome.org/yelp/
- MacPorts - yelp-tools: normalized package name match | MacPorts ports tree: gnome/yelp-tools/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1


## Related links

- [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata.
- [Networking and protocol packages](https://www.automicvault.com/pkg/networking-protocol-tools/) - Matched network, protocol, or remote-service metadata.
- [itstool](https://www.automicvault.com/pkg/brew/itstool/) - Runtime dependency declared by Homebrew.
- [libxml2](https://www.automicvault.com/pkg/brew/libxml2/) - Runtime dependency declared by Homebrew.
- [python@3.14](https://www.automicvault.com/pkg/brew/python-3-14/) - Runtime dependency declared by Homebrew.
- [meson](https://www.automicvault.com/pkg/brew/meson/) - Build dependency declared by Homebrew.
- [ninja](https://www.automicvault.com/pkg/brew/ninja/) - Build dependency declared by Homebrew.
- [pkgconf](https://www.automicvault.com/pkg/brew/pkgconf/) - Build dependency declared by Homebrew.
- [docbook-xsl](https://www.automicvault.com/pkg/brew/docbook-xsl/) - Shares av.db curated category or tags: cli, developer-tools, docbook, documentation.
- [gtk-doc](https://www.automicvault.com/pkg/brew/gtk-doc/) - Shares av.db curated category or tags: cli, developer-tools, documentation, gnome.
- [kdoctools](https://www.automicvault.com/pkg/brew/kdoctools/) - Shares av.db curated category or tags: cli, developer-tools, docbook, documentation.
- [action-docs](https://www.automicvault.com/pkg/brew/action-docs/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [adr-tools](https://www.automicvault.com/pkg/brew/adr-tools/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [adr-viewer](https://www.automicvault.com/pkg/brew/adr-viewer/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [cargo-docset](https://www.automicvault.com/pkg/brew/cargo-docset/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [cheat](https://www.automicvault.com/pkg/brew/cheat/) - Shares av.db curated category or tags: cli, developer-tools, documentation.
- [gi-docgen](https://www.automicvault.com/pkg/brew/gi-docgen/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, developer, developer-tools, documentation, gnome.
- [gspell](https://www.automicvault.com/pkg/brew/gspell/) - Local package facts share a topical domain. Shared terms: cli, developer, developer-tools, gnome.

## Combined YAML source

View the package source record on GitHub. [combined/yelp-tools.yml](https://github.com/automic-vault/db/blob/main/combined/yelp-tools.yml)


## Sources

- Nucleus package database
- Geiger risk classifier
- package-page enrichment
- curated package history
- package version freshness
- av.db category and tag curation
- package relationship graph
- external package-manager database matches
- cross-ecosystem install command graph
