Installation Guide

CODITECT is a cloud-native platform requiring no local installation. However, you may want to set up optional local tools for enhanced workflows.

Cloud Access (Required)

System Requirements

Component	Minimum	Recommended
Browser	Chrome 90+, Firefox 88+, Safari 14+, Edge 90+	Latest version
Internet	5 Mbps	25+ Mbps
Display	1280x720	1920x1080+

Supported Browsers

• Google Chrome (Recommended)
• Mozilla Firefox
• Apple Safari
• Microsoft Edge

Browser Extensions

Some ad blockers or privacy extensions may interfere with real-time collaboration features. If you experience issues, try disabling extensions or using an incognito window.

Optional: CLI Tools

Install the CODITECT CLI for local development integration:

macOS

# Using Homebrew
brew tap coditect-ai/coditect
brew install coditect-cli

# Verify installation
coditect --version

Linux

# Using curl
curl -fsSL https://get.coditect.ai/cli | bash

# Or using apt (Debian/Ubuntu)
curl -fsSL https://apt.coditect.ai/gpg | sudo gpg --dearmor -o /usr/share/keyrings/coditect.gpg
echo "deb [signed-by=/usr/share/keyrings/coditect.gpg] https://apt.coditect.ai stable main" | sudo tee /etc/apt/sources.list.d/coditect.list
sudo apt update && sudo apt install coditect-cli

Windows

# Using winget
winget install coditect.cli

# Or using Chocolatey
choco install coditect-cli

CLI Authentication

After installing the CLI, authenticate with your CODITECT account:

# Start authentication flow
coditect auth login

# This opens your browser for OAuth authentication
# After approval, the CLI is authenticated

Optional: VS Code Extension

For users who prefer local VS Code with cloud workspaces:

1. Open VS Code
2. Go to Extensions (Cmd/Ctrl + Shift + X)
3. Search for "CODITECT"
4. Click Install

Extension Features

• Remote Workspaces: Connect to CODITECT cloud workstations from local VS Code
• AI Integration: Access CODITECT AI features in your local editor
• Sync Settings: Synchronize extensions and settings between local and cloud

Optional: SSH Key Setup

For Git operations and secure terminal access:

Generate SSH Key

# Generate a new ED25519 key (recommended)
ssh-keygen -t ed25519 -C "your-email@example.com"

# Or RSA if ED25519 is not supported
ssh-keygen -t rsa -b 4096 -C "your-email@example.com"

Add to CODITECT

1. Copy your public key:

   # macOS
   pbcopy < ~/.ssh/id_ed25519.pub
   
   # Linux
   cat ~/.ssh/id_ed25519.pub | xclip -selection clipboard
   
   # Windows (PowerShell)
   Get-Content ~/.ssh/id_ed25519.pub | Set-Clipboard

2. Navigate to Dashboard → Settings → SSH Keys

3. Click Add SSH Key

4. Paste your public key and save

Docker Integration (Enterprise)

For enterprise users with on-premises requirements:

Pull Base Images

# Authenticate with CODITECT registry
docker login registry.coditect.ai

# Pull development image
docker pull registry.coditect.ai/coditect/workspace:latest

Docker Compose Setup

# docker-compose.yml
version: '3.8'
services:
  workspace:
    image: registry.coditect.ai/coditect/workspace:latest
    ports:
      - "8080:8080"
    volumes:
      - ./projects:/workspace/projects
    environment:
      - CODITECT_LICENSE_KEY=${CODITECT_LICENSE_KEY}

Verification

After setup, verify your installation:

# Check CLI version
coditect --version

# Verify authentication
coditect auth status

# List available workspaces
coditect workspace list

Expected output:

CODITECT CLI v1.2.0
Authenticated as: user@example.com
Organization: Acme Engineering

Network Configuration

Required Domains

Ensure your network allows access to these domains:

Domain	Purpose
*.coditect.ai	Main application
*.coditect.dev	Preview deployments
registry.coditect.ai	Docker registry
api.coditect.ai	API endpoints
auth.coditect.ai	Authentication

Firewall Rules

Port	Protocol	Purpose
443	HTTPS	Web application
22	SSH	Git operations (optional)

Troubleshooting

Common Issues

Cannot access dashboard

• Check your internet connection
• Verify the domain is not blocked by your network
• Try a different browser or incognito mode

CLI authentication fails

• Ensure you have a valid CODITECT account
• Check if your organization has CLI access enabled
• Try coditect auth logout then coditect auth login

SSH key not working

• Verify the key was added correctly in dashboard
• Check file permissions: chmod 600 ~/.ssh/id_ed25519
• Test with: ssh -T git@coditect.ai

---

Next: Account Setup