Quick Start Guide
Generate your first docs in under 60 seconds
Estimated time: 1 minute
Four Simple Steps
1
Navigate to your project
Open your terminal and navigate to your project directory
$ cd my-awesome-project2
Initialize CodeContext
This will analyze your codebase and create initial documentation
$ codecontext init3
Review generated docs
Check out your new AI-generated README and CHANGELOG
$ cat README.md4
Update documentation
Regenerate docs after making changes to your code
$ codecontext updateWhat Just Happened?
CodeContext just performed some serious magic:
Analyzed Your Codebase
Scanned all files, understood structure and purpose
Used AI to Generate Docs
Created human-friendly documentation instantly
Created Multiple Files
README.md and CHANGELOG.md ready to use
Started Your Free Trial
14 days of Pro features to explore
Try These Commands Next
Generate specific documentation
Create individual doc files
codecontext generate contributingCheck your usage status
See your plan and limits
codecontext statusWatch for changes (Pro)
Auto-update docs on file changes
codecontext update --watchYou're Using the Free Trial
You have access to all Pro features for 14 days. After that, you'll switch to the free plan with:
5
Updates per day
1
Repository
Basic
AI Model