mirror of https://github.com/NickCrew/Claude-Cortex.git synced 2026-09-14 20:17:11 +08:00

Files

T

History

Nick Ferguson a5985a3239 docs(reference): add configuration reference guide

Add comprehensive documentation for all cortex config files:
- cortex-config.json: Main launcher configuration
- memory-config.json: Memory vault settings
- skill-rules.json: Keyword-based skill matching
- recommendation-rules.json: File pattern recommendations
- onboarding-state.json: Wizard completion state

Each section includes schema definition, field descriptions, examples,
and usage instructions. Also adds JSON Schema validation setup for
VS Code and updates settings-files.md with links to the new docs.

2026-01-27 14:03:21 -05:00

api

chore: rename claude-ctx to cortex

2026-01-07 19:21:19 -05:00

architecture

chore: rename claude-ctx to cortex

2026-01-07 19:21:19 -05:00

moved-readmes

docs: update documentation and add new plugins

2026-01-15 17:02:54 -05:00

configuration.md

docs(reference): add configuration reference guide

2026-01-27 14:03:21 -05:00

cortex-tui.1

feat(cli): add first-run wizard for interactive setup

2026-01-17 02:17:24 -05:00

cortex-workflow.1

feat(cli): add first-run wizard for interactive setup

2026-01-17 02:17:24 -05:00

cortex.1

feat(cli): add first-run wizard for interactive setup

2026-01-17 02:17:24 -05:00

index.md

docs(reference): add configuration reference guide

2026-01-27 14:03:21 -05:00

README.md

chore: rename claude-ctx to cortex

2026-01-07 19:21:19 -05:00

README.md

Manpage Generation

Manpages for cortex are auto-generated from the CLI argparse definitions.

📄 Generated Files

cortex.1 - Main command reference
cortex-tui.1 - TUI subcommand reference
cortex-workflow.1 - Workflow subcommand reference

🔄 Regeneration

Manpages are automatically regenerated:

During installation - just install or ./scripts/deprecated/install.sh
Manual generation - just generate-manpages or python3 scripts/generate-manpages.py
Pre-commit hook - When claude_ctx_py/cli.py is modified (optional)

🔧 Setup Pre-commit Hook

To automatically regenerate manpages when CLI changes:

git config core.hooksPath .githooks

📝 Editing

Do NOT manually edit the .1 files - they will be overwritten.

Instead:

Update CLI help text in claude_ctx_py/cli.py
Modify the generator in scripts/generate-manpages.py
Run just generate-manpages to regenerate

🧪 Testing

View generated manpages:

# After generation
man docs/reference/cortex.1

# After installation
man cortex

📅 Version & Date

Version: Extracted from pyproject.toml
Date: Set to generation date (YYYY-MM-DD format)