JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 23
  • Score
    100M100P100Q63343F
  • License MIT

AI-powered documentation generator for developer projects

Package Exports

  • shadowdocs
  • shadowdocs/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (shadowdocs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ShadowDocs

AI-powered documentation generator for developer projects.

Overview

ShadowDocs scans your project and generates professional, detailed README.md files using AI. It analyzes your codebase structure, dependencies, and configuration to create accurate documentation tailored to your project type.

Features

  • AI-Powered Generation: Uses Groq's Llama model for intelligent documentation
  • Project Analysis: Automatically detects project type (CLI, library, frontend, backend)
  • Interactive CLI: Beautiful ink-based interface with keyboard navigation
  • Detailed Output: Generates comprehensive README with all sections
  • Multiple Modes: Generate new, improve existing, or explain in terminal

Installation

npm install -g shadowdocs

Quick Start

shadowdocs

This opens the interactive menu. Use arrow keys or w/s to navigate, Enter to select.

Usage

Interactive Mode (Default)

shadowdocs

Shows menu:

  • Generate README
  • Improve README
  • Explain Project
  • Settings
  • Help

Generate for a Specific Path

shadowdocs ./my-project

Configure API Key

shadowdocs setup

API Key Setup

ShadowDocs uses Groq API for AI generation. Get your free API key:

  1. Visit https://console.groq.com
  2. Create account
  3. Generate API key
  4. Configure via shadowdocs setup or set GROQ_API_KEY env var

Environment Variables

Variable Description
GROQ_API_KEY Your Groq API key
GROK_API_KEY Alternative (Groq)
XAI_API_KEY Alternative (xAI)

Configuration

API key is stored in: ~/.shadowdocs/config.json

Project Types

ShadowDocs automatically detects:

  • CLI - Command-line tools
  • Library - npm packages/modules
  • Frontend - React, Vue, Svelte apps
  • Backend - APIs, servers

Output Sections

Generated README includes:

  • Overview
  • Version
  • Description
  • Features
  • Installation
  • Usage
  • API Reference (if applicable)
  • Development
  • Testing
  • License (MIT)
  • Contributing Guidelines
  • Security Policy
  • Code of Conduct

Requirements

  • Node.js >= 18
  • npm or package manager
  • Groq API key (free tier available)

Commands

Command Description
shadowdocs Interactive menu
shadowdocs ./path Generate for path
shadowdocs setup Configure API key
shadowdocs --help Show help
shadowdocs --version Show version

Development

# Clone
git clone https://github.com/shadowofficial206/shadowdocs.git
cd shadowdocs

# Install dependencies
npm install

# Link locally
npm link

# Test
shadowdocs

Technology Stack

  • Runtime: Node.js 18+
  • UI: Ink (React for CLI)
  • AI: Groq Llama
  • Styling: Chalk
  • HTTP: Axios

License

See LICENSE file for full MIT license text.

Contributing

See CONTRIBUTING.md for contribution guidelines.

Security

See SECURITY.md for security policy and vulnerability reporting.

Support

  • Open an issue for bugs
  • Check existing issues before creating new ones

Made with Ink