How cartographai/quickwiki works
Project type and purpose
• This is an open-source CLI tool (“npx quickwiki-ai”) written in TypeScript/Node.js.
File structure
• Top-level files: package.json, tsconfig.json, jest.config.js, verify-installation script.
• Key directories:
• src/ – all application code
– index.ts: CLI entry point
– services/: core modules (orchestrator, repositoryScanner, documentationGenerator, geminiService)
– models/: shared type definitions
– utils/: cross-cutting concerns (error handling)
– tests/: unit tests for services
• docs/: design documents and specs
• wiki/: generated documentation output
README for additional insights
• Three-step pipeline:
1) explore codebase (repositoryScanner)
2) generate documentation structure (orchestrator)
• External dependency: Google Gemini API