npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

components-compass

v0.1.1

Published

Browse and install framework-neutral Compass Components reference patterns.

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

tdamiaotdamiao

Keywords

compasscomponentsuipatternsclidesign-system

Readme

Compass Components CLI

The components-compass npm package provides the compass command for browsing the Compass Components registry and installing framework-neutral reference patterns. Its first public release, 0.1.0, was bootstrapped manually. Subsequent releases use GitHub Actions Trusted Publishing/OIDC.

Usage

Run a command without a global install:

npx --yes --package=components-compass -- compass list
npx --yes --package=components-compass -- compass search <query>
npx --yes --package=components-compass -- compass search sidebar
npx --yes --package=components-compass -- compass info sidebar
npx --yes --package=components-compass -- compass add sidebar

For a project-local installation:

npm install --save-dev components-compass
npx compass list

After a global installation, invoke the binary directly:

compass list
compass info sidebar
compass add sidebar

Or install globally and use the compass command:

npm install -g components-compass
compass list

add writes the guide, metadata and reference files to compass/<id>/, together with a deterministic compass-source.json provenance manifest. Existing destinations are not overwritten. Planned patterns can be inspected but cannot be installed. add installs a framework-neutral reference pattern for adaptation. It does not automatically integrate the component into an application.

The CLI does not detect a framework, add dependencies or execute downloaded code.

Registry source and compatibility

All default registry URLs and the default ref are centralized in src/registry.js. The CLI defaults to the immutable Compass v1.1.0 registry snapshot and explicitly supports registry schema 1.0.0; unknown schema versions fail with an error instead of being interpreted.

For local development and tests, configure COMPASS_REGISTRY_REF, COMPASS_REGISTRY_URL, and COMPASS_COMPONENTS_BASE_URL. If both URL variables are set, the registry and component files can be served from a local or alternate host. Tests do not require GitHub access.

Compass 1.1.0 is the current ecosystem release. The CLI has its own SemVer track, separate from Compass and from the component versions in registry metadata. See the CLI release procedure.