# intersphinx

> Read and write intersphinx objects.inv files

Latest version **1.1.0** (published 2026-07-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install intersphinx
pnpm add intersphinx
yarn add intersphinx
bun add intersphinx
```

Provides the command `intersphinx`.

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2026-07-06 |
| First published | 2022-09-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 5 |
| Unpacked size | 466.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2 |
| Author | Rowan Cockett |
| Maintainers | rowanc1, stevejpurves |
| Keywords | Sphinx, Intersphinx, Documentation, Python |

## Links

- npm: https://www.npmjs.com/package/intersphinx
- Repository: https://github.com/continuous-foundation/intersphinx
- Issues: https://github.com/continuous-foundation/intersphinx/issues
- npm.io page: https://npm.io/package/intersphinx

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^5.6.2
- [js-yaml](https://npm.io/package/js-yaml.md) ^5.2.1
- [commander](https://npm.io/package/commander.md) ^15.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.2
- [myst-cli-utils](https://npm.io/package/myst-cli-utils.md) ^2.0.14

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2026-07-06
- 1.0.2 — 2023-06-09
- 1.0.1 — 2023-06-09
- 1.0.0 — 2023-06-09
- 0.0.8 — 2023-01-05
- 0.0.7 — 2023-01-04
- 0.0.6 — 2022-12-12
- 0.0.5 — 2022-11-25
- 0.0.4 — 2022-11-14
- 0.0.3 — 2022-10-24
- 0.0.2 — 2022-09-26
- 0.0.1 — 2022-09-16

## README

# intersphinx

[![intersphinx on npm](https://img.shields.io/npm/v/intersphinx.svg)](https://www.npmjs.com/package/intersphinx)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/continuous-foundation/intersphinx/blob/main/LICENSE)
[![CI](https://github.com/continuous-foundation/intersphinx/workflows/CI/badge.svg)](https://github.com/continuous-foundation/intersphinx/actions)

Read and write intersphinx `objects.inv` from node or the command line.

To use from the command line, use the `-g` to create a global install.

```
npm install -g intersphinx
```

## From the command line

Commands available:

`parse`: download or unpack a local file into a json or yaml file.

```bash
intersphinx parse https://docs.python.org/3.7 output.yml
```

`list`: list the contents of an objects.inv

```bash
intersphinx list https://docs.python.org/3.7 --summary
intersphinx list https://docs.python.org/3.7 --domain std
intersphinx list https://docs.python.org/3.7 --domain std:doc --includes abc
intersphinx list https://docs.python.org/3.7 --domain std:doc --includes abc --limit 5
```

## Reading an invintory in Node

```typescript
import { Inventory } from 'intersphinx';

const inv = new Inventory({ id: 'python', path: 'https://docs.python.org/3.7' });
await inv.load();

const entry = inv.getEntry({ name: 'zipapp-specifying-the-interpreter' });
// {
//   location: https://docs.python.org/3.7/library/zipapp.html#specifying-the-interpreter,
//   display: 'Specifying the Interpreter'
// }
```

## Write an invintory

```typescript
import { Inventory, Domains } from 'intersphinx';

const inv = new Inventory({ project: 'Python', version: '3.7' });
inv.setEntry({
  type: Domains.stdLabel,
  name: 'zipapp-specifying-the-interpreter',
  location: 'library/zipapp.html#specifying-the-interpreter',
  display: 'Specifying the Interpreter',
});

inv.write('objects.inv');
```

## Development

This project uses [Bun](https://bun.sh) as its package manager and test runner.

```bash
# Install dependencies
bun install

# Build the library and CLI
bun run build

# Run the test suite (powered by `bun test`)
bun test

# Lint and check formatting
bun run lint
bun run lint:format
```

---

As of v1.0.0 this package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).

---

<p style="text-align: center; color: #aaa; padding-top: 50px">
  Made with love by
  <a href="https://continuous.foundation" target="_blank" style="color: #aaa">
    Continuous Science Foundation <img src="https://cdn.curvenote.com/static/site/csf/icon.svg" style="height: 1em" />
  </a>
</p>

---
_Source: https://npm.io/package/intersphinx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._