Skip to content

README.md

Latest commit

 

History

History
59 lines (44 loc) · 2.58 KB

README.md

File metadata and controls

59 lines (44 loc) · 2.58 KB
Raw

pi-coding-agent Documentation

Welcome to the comprehensive documentation for @mariozechner/pi-coding-agent - a coding agent CLI with read, bash, edit, write tools and session management.

Quick Navigation

Core Documentation

Document Description
01 - Project Overview Purpose, features, operating modes, quick start
02 - Technical Stack Languages, dependencies, architecture patterns
03 - Development Setup Prerequisites, build, test, IDE setup
04 - API Reference Public APIs, functions, classes, types
05 - Data Models Schemas, types, session format, configuration
06 - Deployment Installation, configuration, production setup
07 - Monitoring & Logging Debug, events, troubleshooting
08 - Design Decisions Architecture choices, trade-offs, rationale

Getting Started

  1. New Users: Start with Project Overview for an introduction
  2. Developers: See Development Setup to build from source
  3. SDK Users: Jump to API Reference for programmatic usage
  4. Deploying: Check Deployment for installation options

Project Info

  • Package: @mariozechner/pi-coding-agent
  • Version: 0.49.2
  • License: MIT
  • Author: Mario Zechner
  • Primary Language: TypeScript

Documentation Quality

This documentation has been enhanced to provide comprehensive coverage of the pi-coding-agent project:

  • Completeness: All core modules, APIs, and features documented
  • Accuracy: Verified against actual codebase (package.json, TypeScript interfaces, source code)
  • Examples: Practical code examples and real-world usage scenarios included
  • Troubleshooting: Common issues documented with solutions and debug output
  • Navigation: Table of Contents added to all major documents
  • Developer Experience: IDE setup, debugging configurations, and development workflows covered

Quality Metrics:

  • 8 comprehensive documentation files
  • Table of Contents in 5 major documents
  • 50+ code examples and snippets
  • 30+ troubleshooting scenarios
  • Complete API reference coverage
  • Verified npm scripts documentation
  • Enhanced debugging and monitoring guidance

Last Updated: January 20, 2026

Documentation generated with docgen v4.0 and enhanced by Documentation Enhancement Agent