pascalandy/nia-docs

nia-docs

Browse any documentation site via bash commands using npx nia-docs.

Quick Start

# Browse docs interactively
npx nia-docs "$DOC_URL"

# Execute a single command
npx nia-docs "$DOC_URL" -c "<command>"

Configuration

The nia-docs CLI expects a DOC_URL environment variable pointing to the documentation site:

DOC_URL=

Set this before running any nia-docs commands.

Command Patterns

Search for a topic

npx nia-docs "$DOC_URL" -c "grep -rl 'topic' ."

Read a specific page

npx nia-docs "$DOC_URL" -c "cat page-name.md"

Find all markdown files

npx nia-docs "$DOC_URL" -c "find . -name '*.md'"

List top-level structure

npx nia-docs "$DOC_URL" -c "tree -L 1"

Browse interactively

npx nia-docs "$DOC_URL"

Usage Notes

• The shell starts in the docs root
• Use . for relative paths
• All standard Unix tools work: grep, find, cat, tree, ls, head, tail, wc

Gotchas

• Large documentation sites may take time to index on first run
• Use -c flag for non-interactive commands in scripts
• The tool caches indexed docs for faster subsequent access

Official Documentation

• nia-docs homepage: https://www.agentsearch.sh/
• Tool help: npx nia-docs --help