- 🚀 CLI-First Approach – Efficient command-line interface for documentation generation.
- 📚 AI-Powered – Utilizes LangChain for intelligent document handling and generation.
- 🔄 Pinecone Integration – Seamlessly syncs data with Pinecone for advanced retrieval capabilities.
- 🔍 Customizable Scanning – Configurable file extensions and ignore patterns for precise documentation.
- 🔧 Modular Architecture – Built with TypeScript, enabling easy maintainability and scalability.
- Prerequisites
- Installation
- Quick Start
- Available Scripts
- Project Structure
- Configuration
- Contributing
- License
| Requirement | Version |
|---|---|
| Node.js | >= 18.0.0 |
| npm | 10.0.0 |
git clone https://github.com/SouzaGabriel26/borderless.git
cd HB03-2025_dxgen
npm installnpm run devThis starts the development server.
| Command | Description |
|---|---|
npm run dev |
Start development mode |
npm run dxgen |
Run the documentation generation CLI |
npm run build |
Build for production |
npm run lint |
Lint the project files |
npm run test |
Run the test suite |
HB03-2025_dxgen/
├── apps/
│ └── cli/ # CLI application for dxgen
├── packages/
│ └── rag/ # RAG toolkit for documentation
├── dist/ # Compiled output
├── node_modules/ # Dependency modules
├── package.json # Project metadata and dependencies
└── tsconfig.json # TypeScript configuration
| Variable | Description | Required |
|---|---|---|
OPENAI_API_KEY |
Required for embeddings via @langchain/openai. |
✅ |
PINECONE_API_KEY |
Required for Pinecone data plane access. | ✅ |
PINECONE_CONTROLLER_HOST |
Optional. Override when using multiple Pinecone projects. | ❌ |
- Fork the repository
- Create a feature branch:
git checkout -b feat/feature-name - Commit your changes:
git commit -m 'feat: add feature' - Push to the branch:
git push origin feat/feature-name - Open a pull request
This project is licensed under the ISC License. See the LICENSE file for more details.
Built with ❤️