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

site-index

v0.1.5

Published

CLI for generating sitemap and robots.txt artifacts from site-index modules.

Vulnerabilities

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

Links

Git

Maintainers

sobeaasobeaa

Keywords

site-indexsitemaprobotsseovitecli

Readme

site-index

CLI for creating site-index modules and generating/checking sitemap and robots.txt artifacts.

npm version Code Quality Code Coverage Socket

Repository README

Install

npm install -D site-index

Requirements:

  • Node.js >=22

When to use

Use site-index when you want command-line workflows for:

  • scaffolding *.site-index.* modules
  • generating sitemap and robots.txt artifacts
  • validating site-index modules in CI

When not to use

Global options

  • --quiet: suppress informational output
  • --verbose: enable verbose logging

Commands

make

site-index make <filePath> [--format <format>] [--force]

Behavior:

  • creates a new site-index module template
  • supports --format ts
  • supports --format esm
  • defaults format to ts
  • refuses to overwrite existing files unless --force is used
  • normalizes output filenames to:
    • <name>.site-index.ts
    • <name>.site-index.mjs

build

site-index build --site-url <url> [--root <path>] [--out <dir>] [--config <path>]

Behavior:

  • generates site-index artifacts
  • writes artifacts to --out (default: dist)
  • requires --site-url
  • validates --site-url as a valid URL
  • validates --out resolves within --root
  • uses Vite config when --config is provided
  • --root defaults to current working directory
  • --config must resolve within --root

check

site-index check --site-url <url> [--root <path>] [--config <path>]

Behavior:

  • validates discovered site-index modules for CI
  • requires --site-url
  • fails when warnings are produced
  • uses Vite config when --config is provided
  • --root defaults to current working directory
  • --config must resolve within --root

Examples

npx site-index make src/pages.site-index.ts --format ts
npx site-index make src/pages.site-index.mjs --format esm
npx site-index build --site-url https://example.com
npx site-index check --site-url https://example.com

Local monorepo development:

npm run cli -- build --site-url https://example.com

How it fits in the monorepo

site-index is the user-facing CLI package built on: