Install in VS Code
This is the recommended setup path for new users.
Step 1: Run the Installer
Section titled “Step 1: Run the Installer”From your project root:
npx @coredirective/cf-containerThis creates a .devcontainer/ directory and a .codeforge/ directory in your project.
If .devcontainer/ already exists
Section titled “If .devcontainer/ already exists”Use one of these instead:
npx @coredirective/cf-container --forcenpx @coredirective/cf-container --reset--forceperforms a smart update and preserves your customizations--resetrecreates.devcontainer/from clean defaults while preserving.codeforge/
Step 2: Open the Project in VS Code
Section titled “Step 2: Open the Project in VS Code”Open the project folder in VS Code. If the Dev Containers extension is installed, VS Code should prompt you to reopen the folder in a container.
If you miss the prompt:
- Press
Ctrl+Shift+PorCmd+Shift+P - Run Dev Containers: Reopen in Container
Step 3: Wait for the First Build
Section titled “Step 3: Wait for the First Build”The first build usually takes several minutes. During that time CodeForge is:
- Pulling the base image
- Installing features and runtimes
- Deploying configuration and shell aliases
- Activating plugins and setup scripts
Do not interrupt the first build unless it is clearly stuck. If it fails halfway through, rebuild without cache.
What Gets Created
Section titled “What Gets Created”your-project/├── .devcontainer/│ ├── devcontainer.json│ ├── .env│ ├── features/│ ├── plugins/│ └── scripts/├── .codeforge/│ ├── file-manifest.json│ ├── config/│ └── scripts/└── ...your existing filesWhat to Do Next
Section titled “What to Do Next”Once the container is open and the terminal is available, continue to Verify Your Install.