Skip to content

AI-powered documentation fetcher for the terminal using Google Gemini

Notifications You must be signed in to change notification settings

Nik-09/doc-pilot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

2 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

doc-pilot ๐Ÿš€

AI-powered documentation fetcher for the terminal using Google Gemini.

Features

  • ๐Ÿ“š Fetch library documentation directly in your terminal
  • ๐Ÿค– Powered by Google Gemini AI
  • ๐Ÿ“ฆ Auto-detects library versions from your package.json
  • โš™๏ธ Simple configuration management
  • ๐ŸŽจ Beautiful colored output

Installation

From npm (Recommended)

npm install -g doc-pilot

From source

git clone https://github.com/Nik-09/doc-pilot.git
cd doc-pilot
npm install
npm link

Setup

  1. Get a Gemini API key from Google AI Studio

  2. On first use, the tool will prompt you for your API key:

doc-pilot find express use

Or set it manually:

doc-pilot config --set-api-key

Usage

Find documentation

doc-pilot find <library> <function>

Examples:

# Get documentation for express.use()
doc-pilot find express use

# Get documentation for Array.map()
doc-pilot find Array map

# Get documentation for lodash.debounce()
doc-pilot find lodash debounce

Configuration commands

# Show current configuration
doc-pilot config --show-config

# Set or update API key
doc-pilot config --set-api-key

# Reset configuration
doc-pilot config --reset

How it works

  1. You run the command with a library and function name
  2. doc-pilot checks if the library is in your local package.json
  3. It queries Google Gemini with version context (if available)
  4. Returns formatted documentation with examples

Configuration

Configuration is stored in ~/.doc-pilot/config.json

Requirements

  • Node.js 18+
  • Gemini API key

Dependencies

  • @google/genai - Google Gemini API SDK
  • chalk - Terminal styling
  • commander - CLI framework

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

ISC

About

AI-powered documentation fetcher for the terminal using Google Gemini

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published