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 🙏

© 2025 – Pkg Stats / Ryan Hefner

@deepguide-ai/dg

v3.1.5

Published

Self-testing CLI documentation tool that generates interactive terminal demos

Downloads

44

Vulnerabilities

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

Links

Git

Maintainers

deepguidedeepguide

Keywords

clidocumentationterminalasciinemademosself-testing

Readme

DeepGuide CLI

Demo status npm version CI Status License: MIT

Transform your CLI documentation from static code blocks or heavy GIF/Video into self-testing, interactive, lightweight demos that stay current automatically.

Use dg to capture your terminal session

Captured using dg. We dogfood ourselves.

Capture - light Capture - dark

Installation

Via npm (recommended)

# Install globally
sudo npm install -g @deepguide-ai/dg

# Or run without installing
npx @deepguide-ai/dg init

Requirements

  • Node.js 18+ - The CLI runs on Node.js
  • termsvg - For recording terminal sessions (auto-installed on first use)

Verify Installation

dg doctor

This will check that all dependencies are properly installed.

Quick Start

npx @deepguide-ai/dg init  # 30-second setup
dg capture                 # Record interactive demo
dg validate                # Test in CI - PR fails if broken

Core Commands

| Command | Purpose | Example | |---------|---------|---------| | dg init | Interactive setup wizard | npx @deepguide-ai/dg init | | dg capture | Record CLI demos | dg capture | | dg validate | Test demos in CI | dg validate | | dg list | Show status | dg list | | dg doctor | Environment diagnostics | dg doctor |

FAQ

Q: How does validation work?

A: DG re-runs your original commands and compares exit codes + filtered output. Interactive demos are automatically skipped in CI.

Q: What platforms are supported?

A: All platforms supported by Node.js 18+: macOS, Linux. Requires Node.js runtime. Windows is supported through WSL.

Q: How big are the generated assets?

A: SVG demos are typically 50-100x smaller than equivalent GIFs.

Examples in the Wild

See DG in action:

  • Demo - Demo Project for dg

Want your project listed? Open a PR!

Contributing

We welcome contributions! See our Contributing Guide.

Development Setup

git clone https://github.com/deepguide-ai/dg.git
cd dg
pnpm install
pnpm run build
pnpm run dev

Testing

pnpm test              # Unit tests (when available)
pnpm run build         # Build TypeScript
node dist/index.js    # Test built CLI

Support

  • 🐛 Issues - Bug reports and feature requests
  • 💬 Discussions - Questions and community
  • 📧 Email - Direct support

Credits

DeepGuide CLI builds upon these amazing open source projects:

  • asciinema - The core terminal session recorder that powers our demo capture. GPL-3.0 licensed.
  • node-pty - Pseudoterminal implementation that enables cross-platform terminal recording. MIT licensed.
  • termsvg - Terminal session to SVG renderer that creates our lightweight, beautiful demo outputs. GPL-3.0 licensed.

Special thanks to the maintainers and contributors of these projects! ❤️

License

MIT - The main CLI tool is MIT licensed for maximum compatibility.

Platform packages containing termsvg binaries are GPL-3.0 licensed. Enterprise users can avoid GPL binaries with DG_GPL_OFF=1.

Made with ❤️ by the DeepGuide team

Transform your CLI documentation from static to spectacular.