OCode Documentation

Welcome to the OCode documentation. This comprehensive guide covers everything from getting started to advanced development.

Quick Links

• New to OCode? Start with the Quickstart Guide
• Need help with tools? See the Tool Reference
• Configuring OCode? Check the Configuration Guide
• Want to contribute? Read our Contributing Guide

Documentation Structure

Getting Started

• Quickstart Guide - Get up and running in 5 minutes
• Installation Guide - Detailed installation instructions
• First Project - Your first OCode project walkthrough
• Troubleshooting - Common issues and solutions

User Guide

• Configuration - Complete configuration reference
• Tool Reference - All available tools
  • File Operations
  • Text Processing
  • Data Processing
  • System Operations
  • Development Tools
• Workflows - Common workflows and patterns
• Best Practices - Tips for effective usage

Developer Guide

• Architecture - System architecture overview
• Creating Tools - How to build custom tools
• Language Support - Adding language analyzers
• Testing - Testing strategies and patterns
• Contributing - Contribution guidelines

API Reference

• Tools API - Complete tool system API
• Engine API - Core engine API
• Context Manager API - Context system API
• MCP Protocol - Model Context Protocol

Advanced Topics

• Security - Security model and configuration
• Performance - Performance optimization
• MCP Integration - Advanced MCP usage
• Deployment - Production deployment

Technical Documentation

• Timeout Analysis - Timeout implementation across codebase
• Reliability Improvements - Error handling improvements
• Manual CLI Testing - CLI testing procedures

Key Concepts

Tools

OCode provides 19+ specialized tools for various tasks:

• File Operations: Read, write, edit, search files
• Text Processing: Grep, diff, sort, analyze text
• System Tools: Execute commands, manage environment
• Development: Git operations, testing, notebooks
• Analysis: Architecture analysis, extended reasoning

Context Management

OCode intelligently analyzes your project to provide relevant context:

• Automatic file discovery and ranking
• Language-specific symbol extraction
• Dependency tracking
• Git integration

Security Model

Multi-layer security system:

• Path-based restrictions
• Command validation
• Permission system
• User confirmation for dangerous operations

Getting Help

In OCode

# General help
ocode -p "What can you do?"

# Tool-specific help
ocode -p "How do I use the grep tool?"

# Feature help
ocode -p "How do I search for text in files?"

Community

• GitHub Discussions - Ask questions
• Issue Tracker - Report bugs
• Discord Server - Live chat with community

Contributing to Documentation

We welcome documentation improvements! When contributing:

1. Follow Structure: Place docs in appropriate directories
2. Be Clear: Write for your target audience (users vs developers)
3. Include Examples: Show, don't just tell
4. Stay Current: Update docs when features change
5. Test Code: Ensure all code examples work

See our Contributing Guide for details.

Version

This documentation is for OCode v2.0+. For older versions, see the releases page.