Skip to content

README.md

Latest commit

 

History

History
48 lines (37 loc) · 1.09 KB

README.md

File metadata and controls

48 lines (37 loc) · 1.09 KB
Raw

OpenSIPS Documentation Collector

CLI tool that discovers, extracts, and consolidates OpenSIPS documentation into structured JSON using MASTRA workflows and LLM-backed extraction.

Requirements

  • Node.js 18+
  • API key for at least one provider:
    • GOOGLE_API_KEY
    • OPENAI_API_KEY
    • ANTHROPIC_API_KEY

Install

npm install

Configure

Copy the example env file and fill in keys:

cp .env.example .env

Usage

# Start or resume collection
node dist/index.js collect -v 3.6

# Show status
node dist/index.js status -v 3.6

# Retry failed items
node dist/index.js retry -v 3.6

# List known versions
node dist/index.js list

# Collect a single module
node dist/index.js collect-module -v 3.6 -m dialog

CLI Options

  • --fresh: Restart from scratch.
  • --provider: Override LLM provider (google, openai, anthropic).
  • --output: Override output directory (default ./data).

Prompt Templates

Prompt templates live in src/config/promts.config.ts (source of truth). The Markdown guide in docs/opensips-llm-extraction-prompts.md is synced from it.