Skip to content
ocx
install

OCX Catalog

@ocx-sh/catalog renders one or more OCX package indices into a browsable static site: a package grid, per-package detail pages with README, platforms, versions and install commands, client-side search, and an optional docs section.

It is a renderer, not a producer. Point it at an index — a local directory, an HTTPS endpoint, or a git repository — and it builds a site around what is already there. It never writes to an index and never invents index data. See Index vs. catalog for where that line sits.

Terminal window
npm install --save-dev @ocx-sh/catalog

Node.js >=22.13. The package bundles its renderer, so there are no peer dependencies to install. Then work through the Quickstart.

Upgrading from 0.5? Read Upgrade to 0.6 first.

  • How-To covers task-shaped guides: quickstart, sources, deploys, local preview and branding.
  • Reference lists CLI flags and exit codes, the config schema, CI rendering and the output layout.
  • Explanation covers why the design is the way it is: ownership, multi-source and the security model.
  • Ops covers limitations, host selection and troubleshooting.