codecontext update
Regenerate documentation with latest code changes
The update command analyzes your codebase and regenerates documentation to reflect recent changes. It intelligently merges updates while preserving your custom content.
$ codecontext updateOptions
--watch, -w
Continuously watch for file changes and auto-update documentation
$ codecontext update --watch--force, -f
Force regeneration of all documentation files, ignoring cache
$ codecontext update --force--files, -f
Update only specific documentation files
$ codecontext update --files readme,changelogHow Updates Work
Analyze Changes
CodeContext scans your codebase for changes since the last update
Generate New Content
AI analyzes the changes and generates updated documentation
Smart Merge
Updates are intelligently merged, preserving your custom sections
Save & Report
Files are updated and you get a summary of changes
Watch ModePRO
Pro users can enable watch mode to automatically update documentation as they code:
Benefits:
- • Real-time documentation updates
- • Never forget to update docs
- • Perfect for rapid development
Configurable:
- • Debounce time
- • Ignore patterns
- • Update frequency
Preserving Custom Content
Smart Updates
CodeContext preserves your custom content during updates. Use these markers:
<!-- CUSTOM-SECTION-START --> Your custom content here... This won't be overwritten! <!-- CUSTOM-SECTION-END -->
Common Use Cases
After Adding New Features
Update docs to include your new functionality:
$ codecontext updateBefore Release
Ensure docs are current before tagging a release:
$ codecontext update --forceDuring Development (Pro)
Keep docs always in sync while coding:
$ codecontext update --watchTroubleshooting
Updates are overwriting my custom content
Make sure to wrap custom content in CUSTOM-SECTION markers. Also ensure you're not using --force flag unless necessary.
No changes detected
CodeContext uses git to detect changes. Make sure you've committed your changes or use --force to regenerate everything.
Update is taking too long
For large projects, updates can take time. Use --files flag to update only specific documentation files.