Installing the ChapterWise Codex Extension

This guide walks you through installing the ChapterWise Codex extension in VS Code or Cursor.

Prerequisites

The extension works with both:

• Visual Studio Code — Version 1.85.0 or later
• Cursor — All versions supported

Both editors provide identical functionality. Choose whichever you prefer for your workflow.

Installation Methods

Option 1: Install from VSIX File

If you have a .vsix package file:

VS Code

1. Open VS Code
2. Open the Command Palette (Cmd+Shift+P on Mac, Ctrl+Shift+P on Windows/Linux)
3. Type "Install from VSIX" and select Extensions: Install from VSIX...
4. Navigate to and select the chapterwise-codex-x.x.x.vsix file
5. Click Install
6. Reload the window when prompted

Cursor

1. Open Cursor
2. Open a terminal (Cmd+`` or Ctrl+``)
3. Run the following command:

cursor --install-extension /path/to/chapterwise-codex-x.x.x.vsix --force

1. Reload the window (Cmd+Shift+P → "Reload Window")

Option 2: Build from Source

If you have the source code:

# Navigate to the extension directory
cd chapterwise-codex

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Package the extension
npm run package

# Install in VS Code
code --install-extension chapterwise-codex-0.1.0.vsix --force

# Or install in Cursor
cursor --install-extension chapterwise-codex-0.1.0.vsix --force

Option 3: VS Code Marketplace (Coming Soon)

The extension will be available on the VS Code Marketplace in a future release. Once published, you'll be able to:

1. Open the Extensions view (Cmd+Shift+X / Ctrl+Shift+X)
2. Search for "ChapterWise Codex"
3. Click Install

Verifying Installation

After installation, verify the extension is working:

1. Check Extensions List

Open the Extensions view and search for "ChapterWise". You should see the extension listed as installed.

2. Open a Codex File

Create or open a file with .codex.yaml or .codex.json extension. You should see:

• Syntax highlighting — YAML/JSON with Codex-aware colors
• Tree view — A "Codex Structure" panel in the Explorer sidebar
• Validation — Any errors will appear as squiggly underlines

3. Test the Command Palette

1. With a Codex file open, press Cmd+Shift+P / Ctrl+Shift+P
2. Type "ChapterWise" to see available commands:
3. ChapterWise Codex: Explode Codex
4. ChapterWise Codex: Implode Codex
5. ChapterWise Codex: Update Word Count
6. ChapterWise Codex: Generate Tags
7. ChapterWise Codex: Open Writer's View

Troubleshooting

Extension Not Activating

The extension only activates for .codex.yaml and .codex.json files. Make sure your file has the correct extension.

Tree View Not Showing

1. Open the Explorer sidebar (Cmd+Shift+E / Ctrl+Shift+E)
2. Look for the "Codex Structure" section
3. If collapsed, click to expand it
4. Make sure you have a valid Codex file open

Validation Not Working

The extension validates against the Codex schema. If validation isn't working:

1. Ensure the file is saved
2. Check the Problems panel (Cmd+Shift+M / Ctrl+Shift+M) for errors
3. Verify the file has valid YAML/JSON syntax

Commands Not Available

Commands only appear when a Codex file is the active editor. Open a .codex.yaml or .codex.json file first.

Updating the Extension

To update to a newer version:

1. Download or build the new .vsix file
2. Follow the installation steps above
3. The --force flag will replace the existing version

Uninstalling

VS Code / Cursor

1. Open the Extensions view
2. Find "ChapterWise Codex"
3. Click the gear icon and select Uninstall
4. Reload the window

Or via command line:

# VS Code
code --uninstall-extension chapterwise-codex

# Cursor
cursor --uninstall-extension chapterwise-codex

Next: Learn about all the Features available in the extension.