# Install esbonio with Homebrew

Language server for working with Sphinx projects. Version 2.1.0 via Homebrew; verified 2026-07-07.

## Install

```sh
sudo av install brew:esbonio
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install esbonio
```

  Evidence: local Homebrew formula metadata

## Package facts

- **Package key:** brew:esbonio
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/esbonio>
- **Version:** 2.1.0
- **Source summary:** Language server for working with Sphinx projects
- **Homepage:** <https://github.com/swyddfa/esbonio>
- **Repository:** <https://github.com/swyddfa/esbonio>
- **License:** MIT
- **Source archive:** <https://files.pythonhosted.org/packages/68/e6/b40e53f2efc28fc18319795800cd3cc1dca6215cf34b55d0183361adebff/esbonio-2.1.0.tar.gz>
- **Last updated:** 2026-07-07T10:01:21Z
- **Generated:** 2026-08-04T22:13:35+00:00

## Executables

- esbonio (cli)
- esbonio (alias)

## Dependencies

- python@3.14

## 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: 2.1.0
- Package-manager updated: 2026-07-07
- Local data: ok
- Upstream repository: https://github.com/swyddfa/esbonio
- info: No cached GitHub release or tag data was available.
## Project history and usage

Esbonio is a language server for Sphinx documentation projects. It provides editor features such as references, completions, diagnostics, previews, and extension points for documentation tooling.

### Project history

The project is hosted in the official swyddfa/esbonio repository and is organized around a Python language server, a VS Code extension, and Sphinx extensions. Its documentation describes Esbonio as tooling that reduces friction when writing Sphinx content.

The 1.0 release in October 2025 changed the server architecture by moving Sphinx builds into background processes, adding support for multi-root and multiple Sphinx projects in a workspace, and expanding configuration sources beyond initialization options.

The 2.x releases in 2026 continued the migration with Sphinx 9 support, command changes, logging changes, and a dedicated `esbonio sphinx build` command.

### Adoption history

Esbonio is packaged as a Homebrew formula and as editor-facing tooling, especially through its VS Code extension and documented integrations for editors such as Emacs and Neovim.

Its adoption follows Sphinx users who want language-server behavior while editing reStructuredText or MyST documentation, rather than treating documentation as plain text plus an external build step.

### How it is used

Typical use is to install or launch the Esbonio language server from an editor integration and let it run Sphinx builds in the background for completion, diagnostics, references, and live preview.

Project-specific configuration is documented through `pyproject.toml` under `[tool.esbonio.sphinx]`, with settings such as build arguments, configuration overrides, Python command, environment, and working directory.

### Why package nerds care

Esbonio is notable to package-manager users because it turns a documentation build system into editor infrastructure: a Homebrew-installed CLI/server can support Sphinx projects across editor clients.

It sits at the intersection of Python packaging, Sphinx documentation workflows, Language Server Protocol clients, and editor extensions.

### Timeline

- 2025-10-28: Esbonio Language Server v1.0.0 released with background Sphinx process architecture and expanded configuration.
- 2026-02-19: v1.1.0 introduced `esbonio.sphinx.buildArguments` and documented project discovery.
- 2026-04-11: v2.0.0 dropped Sphinx 6 support, changed command behavior, and added Sphinx 9 support.
- 2026-06-28: v2.1.0 added `esbonio sphinx build`.

### Related projects

- Sphinx is the documentation system Esbonio targets.
- The Language Server Protocol defines the editor integration model.
- The official repository also includes a VS Code extension and Sphinx extension packages.

### Sources

- <https://docs.esbon.io/>
- <https://docs.esbon.io/en/release/about/changelog.html>
- <https://docs.esbon.io/en/release/usage/reference/configuration.html>
- <https://github.com/swyddfa/esbonio>
- <https://github.com/swyddfa/esbonio/discussions/1041>


## Security Notes

No matching local secret-handling manifest was found for esbonio. Package metadata is still published here so future coverage has a stable package URL.



## 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: pyproject.toml
## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** esbonio
- **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.
- [Text processing packages](https://pkg.so/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Developer build packages](https://pkg.so/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata.
- [python@3.14](https://pkg.so/brew/python-3-14/) - Runtime dependency declared by Homebrew.
- [python-lsp-server](https://pkg.so/brew/python-lsp-server/) - Shares pkgdb curated category or tags: cli, developer-tools, language-server, lsp, python.
- [cmake-language-server](https://pkg.so/brew/cmake-language-server/) - Shares pkgdb curated category or tags: cli, developer-tools, language-server, lsp, python.
- [lua-language-server](https://pkg.so/brew/lua-language-server/) - Shares pkgdb curated category or tags: cli, developer-tools, language-server, lsp.
- [gopls](https://pkg.so/brew/gopls/) - Shares pkgdb curated category or tags: cli, developer-tools, language-server, lsp.
- [marksman](https://pkg.so/brew/marksman/) - Shares pkgdb curated category or tags: cli, developer-tools, language-server, lsp.
- [bash-language-server](https://pkg.so/brew/bash-language-server/) - Shares pkgdb curated category or tags: cli, developer-tools, language-server, lsp.
- [elixir-ls](https://pkg.so/brew/elixir-ls/) - Shares pkgdb curated category or tags: cli, developer-tools, language-server, lsp.
- [ansible-language-server](https://pkg.so/brew/ansible-language-server/) - Shares pkgdb curated category or tags: cli, developer-tools, language-server, lsp.
- [jdtls](https://pkg.so/brew/jdtls/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, developer, developer-tools, language, language-server.

## Combined YAML source

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


## Sources

- pkg.so package database
- 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
