Skip to main content

CODITECT Pilot Developer Invitation Email

Subject: Welcome to CODITECT - Developer Setup Instructions

For: Developers and contributors working on the CODITECT framework

Hi [DEVELOPER_NAME],

Welcome to the CODITECT contributor team! You've been invited to help develop and improve the CODITECT AI development framework.

Developer vs User Setup​

AspectUser SetupDeveloper Setup
ScriptCODITECT-CORE-INITIAL-SETUP.pyCODITECT-DEVELOPER-SETUP.py
Steps10 steps8 steps
InstallationProtected locationSubmodule (editable)
~/.coditect Points ToProtected installYour submodule
Can Edit FrameworkNoYes
Context ServicesAuto-installed (launchd)Build from source (optional)

Getting Started (15 minutes)​

Step 1: Clone the Parent Repository​

cd ~/PROJECTS
git clone --recursive https://github.com/az1ai/coditect-rollout-master.git
cd coditect-rollout-master

The --recursive flag clones all submodules including coditect-core.

Step 2: Navigate to coditect-core​

cd submodules/core/coditect-core
ls CLAUDE.md   # Verify you're in the right place

Step 3: Run Developer Setup​

python3 H.P.004-SCRIPTS/CODITECT-DEVELOPER-SETUP.py

Or download directly:

curl -sL https://storage.googleapis.com/coditect-dist/H.P.004-SCRIPTS/CODITECT-DEVELOPER-SETUP.py | python3

Step 4: What Happens (8 Steps)​

StepWhat Happens
1Detect environment (submodule vs standalone)
2Backup any existing protected installation
3Configure symlinks to point to your submodule
4Initialize context database (8 tables with FTS5)
5Generate your unique machine ID
6Configure Claude Code H.P.005-HOOKS
7Configure statusline (7 sections)
8Set up Python virtual environment

Step 5: Verify Your Installation​

# Check symlinks point to SUBMODULE (not protected location)
ls -la ~/.coditect
# Should show: -> /Users/you/PROJECTS/.../submodules/core/coditect-core

# Verify CLAUDE.md is accessible
cat ~/.coditect/CLAUDE.md | head -5

# Check database
sqlite3 ~/PROJECTS/.coditect-data/context-storage/context.db ".tables"
# Should show: decisions errors messages migrations patterns sessions skill_learnings sync_queue

# Check machine ID
cat ~/.coditect/machine-id.json | head -5

Step 6: Start Developing​

# Activate environment
source ~/.coditect/.venv/bin/activate

# Start Claude Code
cd ~/PROJECTS/coditect-rollout-master
claude

# Run orientation
/orient

Developer Workflow​

Making Changes​

# 1. Create feature branch
cd submodules/core/coditect-core
git checkout -b feature/my-feature

# 2. Make your changes

# 3. Commit to submodule
git add .
git commit -m "feat: Add my feature"

# 4. Push and create PR
git push -u origin feature/my-feature
gh pr create

Updating Parent Repository​

After your submodule changes are merged:

cd ~/PROJECTS/coditect-rollout-master
git add submodules/core/coditect-core
git commit -m "chore: Update coditect-core submodule"
git push

Key Differences from User Setup​

  1. Symlinks point to your editable submodule, not a protected location
  2. Context services are optional - build from source if needed: 
    cd ~/.coditect/tools/context-watcher
    cargo build --release
    cp target/release/coditect-context-watch ~/.coditect/bin/
  3. Your changes are immediately reflected via the symlink
  4. You can edit framework files directly and test locally

Gitignored Files (Machine-Specific)​

These files are created but not committed:

File/DirectoryPurpose
context-storage/Session data, database
machine-id.jsonYour machine's unique ID
session-logs/Machine-specific logs
logs/Service logs
.venv/Python virtual environment

Requirements​

  • macOS 12.0+ or Linux (Ubuntu 20+)
  • Python 3.9+
  • Git 2.30+
  • GitHub Account with collaborator access
  • Claude Max subscription for AI features

Documentation​

Need Help?​

Welcome to the team! We're excited to have you contributing.

Best regards, The CODITECT Team

Script Version: 2.0.0 | Copyright (c) 2025-2026 AZ1.AI Inc. All Rights Reserved.