Documentation for developers building CLI applications with TimeWarp.Nuru.
This section contains guides, tutorials, and reference materials for users of the TimeWarp.Nuru library - developers who want to build command-line applications using Nuru's routing framework.
| User Documentation | Developer Documentation |
|---|---|
| Audience: CLI app builders | Audience: Nuru contributors |
| Focus: How to use Nuru | Focus: How Nuru works internally |
| Content: Guides, tutorials, API reference | Content: Architecture, design decisions |
Location: documentation/user/ |
Location: documentation/developer/ |
Quick start guide to building your first CLI app with TimeWarp.Nuru.
Real-world scenarios and patterns:
- Greenfield CLI applications
- Progressive enhancement of existing tools
- Command interception and routing strategies
Practical implementation guides:
- Architecture choices (Direct, Mediator, Mixed)
- Deployment strategies (AOT, runfiles, cross-platform)
- Migration from other frameworks
- Best practices
Detailed feature documentation:
- Routing patterns and syntax
- Roslyn Analyzer (compile-time validation)
- Logging system
- Auto-help generation
- Output handling (stdout/stderr, JSON)
Supporting tools and integrations:
- MCP Server (AI-assisted development)
- Testing utilities
- Build tools
Technical reference materials:
- Performance benchmarks
- Supported types
- API documentation
Step-by-step learning paths:
- Your first CLI app
- Adding dependency injection
- Testing CLI applications
- Samples - Complete working examples you can run
- Developer Documentation - For contributors to TimeWarp.Nuru
- Cocona Comparison - Migration guides from Cocona