{"id":27275170,"url":"https://github.com/continuous-foundation/intersphinx","last_synced_at":"2026-02-21T11:01:59.051Z","repository":{"id":103763792,"uuid":"585672349","full_name":"continuous-foundation/intersphinx","owner":"continuous-foundation","description":"Read and write intersphinx `objects.inv` from node or the command line.","archived":false,"fork":false,"pushed_at":"2024-11-29T22:44:20.000Z","size":375,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-11T15:56:48.913Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/continuous-foundation.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-05T19:19:44.000Z","updated_at":"2024-11-29T22:44:24.000Z","dependencies_parsed_at":"2024-11-29T23:36:23.435Z","dependency_job_id":null,"html_url":"https://github.com/continuous-foundation/intersphinx","commit_stats":{"total_commits":19,"total_committers":1,"mean_commits":19.0,"dds":0.0,"last_synced_commit":"e4ecfbabc2fab5118b1980f1d16e14d878c16211"},"previous_names":["continuous-foundation/intersphinx"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/continuous-foundation/intersphinx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Fintersphinx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Fintersphinx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Fintersphinx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Fintersphinx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/continuous-foundation","download_url":"https://codeload.github.com/continuous-foundation/intersphinx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/continuous-foundation%2Fintersphinx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29679049,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T09:33:50.764Z","status":"ssl_error","status_checked_at":"2026-02-21T09:33:19.949Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-11T15:31:05.100Z","updated_at":"2026-02-21T11:01:59.035Z","avatar_url":"https://github.com/continuous-foundation.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# intersphinx\n\n[![intersphinx on npm](https://img.shields.io/npm/v/intersphinx.svg)](https://www.npmjs.com/package/intersphinx)\n[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/continuous-foundation/intersphinx/blob/main/LICENSE)\n[![CI](https://github.com/continuous-foundation/intersphinx/workflows/CI/badge.svg)](https://github.com/continuous-foundation/intersphinx/actions)\n\nRead and write intersphinx `objects.inv` from node or the command line.\n\nTo use from the command line, use the `-g` to create a global install.\n\n```\nnpm install -g intersphinx\n```\n\n## From the command line\n\nCommands available:\n\n`parse`: download or unpack a local file into a json or yaml file.\n\n```bash\nintersphinx parse https://docs.python.org/3.7 output.yml\n```\n\n`list`: list the contents of an objects.inv\n\n```bash\nintersphinx list https://docs.python.org/3.7 --summary\nintersphinx list https://docs.python.org/3.7 --domain std\nintersphinx list https://docs.python.org/3.7 --domain std:doc --includes abc\nintersphinx list https://docs.python.org/3.7 --domain std:doc --includes abc --limit 5\n```\n\n## Reading an invintory in Node\n\n```typescript\nimport { Inventory } from 'intersphinx';\n\nconst inv = new Inventory({ id: 'python', path: 'https://docs.python.org/3.7' });\nawait inv.load();\n\nconst entry = inv.getEntry({ name: 'zipapp-specifying-the-interpreter' });\n// {\n//   location: https://docs.python.org/3.7/library/zipapp.html#specifying-the-interpreter,\n//   display: 'Specifying the Interpreter'\n// }\n```\n\n## Write an invintory\n\n```typescript\nimport { Inventory, Domains } from 'intersphinx';\n\nconst inv = new Inventory({ project: 'Python', version: '3.7' });\ninv.setEntry({\n  type: Domains.stdLabel,\n  name: 'zipapp-specifying-the-interpreter',\n  location: 'library/zipapp.html#specifying-the-interpreter',\n  display: 'Specifying the Interpreter',\n});\n\ninv.write('objects.inv');\n```\n\n---\n\nAs of v1.0.0 this package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).\n\n---\n\n\u003cp style=\"text-align: center; color: #aaa; padding-top: 50px\"\u003e\n  Made with love by\n  \u003ca href=\"https://continuous.foundation\" target=\"_blank\" style=\"color: #aaa\"\u003e\n    Continuous Science Foundation \u003cimg src=\"https://continuous.foundation/images/logo-small.svg\" style=\"height: 1em\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontinuous-foundation%2Fintersphinx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontinuous-foundation%2Fintersphinx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontinuous-foundation%2Fintersphinx/lists"}