Skip to content

INSTALL.md

Latest commit

 

History

History
207 lines (146 loc) · 5 KB

INSTALL.md

File metadata and controls

207 lines (146 loc) · 5 KB

Claude Conductor - Installation Guide

This document provides installation instructions for both automated and manual methods.

Method 1: NPM Install (Recommended)

The simplest way - one command and you're done:

npm install -g @vibecodingwithphill/claude-conductor

That's it! The postinstall script automatically:

  1. Finds your Claude settings (~/.claude/settings.json)
  2. Registers the conductor skills
  3. Preserves any existing settings

Verify installation:

claude-conductor status

Method 2: GitHub + Claude Setup

If a user pastes this GitHub repo URL into Claude and asks for setup, Claude should follow these instructions:

For Claude AI - Installation Instructions

When a user asks you to install Claude Conductor from this repository, perform these steps:

Step 1: Determine Installation Location

Choose an appropriate location for the user:

  • Windows: C:\Users\{USERNAME}\Tools\claude-conductor
  • macOS/Linux: ~/tools/claude-conductor or ~/.local/share/claude-conductor

Ask the user if they have a preferred location, or use the default.

Step 2: Clone or Download the Repository

If git is available:

git clone https://github.com/VibeCodingWithPhil/claude-conductor.git {INSTALL_PATH}

Or download and extract the files to the chosen location.

Step 3: Register in Claude Settings

Read the user's Claude settings file:

  • Location: ~/.claude/settings.json

If the file doesn't exist, create it. If it exists, preserve all existing settings.

Add/update the conductor skill registration:

{
  "skills": {
    "conductor": {
      "path": "{INSTALL_PATH}"
    }
  }
}

Important: Replace {INSTALL_PATH} with the actual absolute path where files were installed.

Step 4: Verify Installation

Confirm to the user:

  1. Files are installed at {INSTALL_PATH}
  2. Settings updated at ~/.claude/settings.json
  3. The following commands are now available:
    • /conductor:setup
    • /conductor:newTrack
    • /conductor:implement
    • /conductor:status
    • /conductor:revert

Step 5: Test (Optional)

The user can test by typing /conductor:status in any project.

Method 3: Manual Installation

For users who prefer full control:

1. Download Files

Download or clone the repository to a permanent location:

{your-chosen-path}/claude-conductor/
├── skills.json
├── commands/
│   ├── setup.md
│   ├── newTrack.md
│   ├── implement.md
│   ├── status.md
│   └── revert.md
└── templates/
    └── ...

2. Edit Claude Settings

Open or create ~/.claude/settings.json and add:

{
  "skills": {
    "conductor": {
      "path": "/absolute/path/to/claude-conductor"
    }
  }
}

3. Verify

Start a new Claude Code session and type /conductor:setup.

Updating Claude Conductor

NPM Method

npm update -g @vibecodingwithphill/claude-conductor

GitHub/Manual Method

Pull latest changes or re-download:

cd {INSTALL_PATH}
git pull

No settings changes needed - updates are automatic.

Uninstalling

NPM Method

claude-conductor uninstall  # Remove from Claude settings
npm uninstall -g @vibecodingwithphill/claude-conductor  # Remove package

Manual Method

  1. Remove the conductor entry from ~/.claude/settings.json
  2. Delete the installation folder

Troubleshooting

"Command not found" after NPM install

  • Ensure npm global bin is in your PATH
  • Try: npx @vibecodingwithphill/claude-conductor status

Skills not appearing in Claude

  • Verify path in ~/.claude/settings.json is correct
  • Check that skills.json exists in that path
  • Restart Claude Code session

Permission errors on install

  • Try with sudo (Unix): sudo npm install -g @vibecodingwithphill/claude-conductor
  • Or use a user-writable npm prefix

Platform-Specific Notes

Windows

  • Paths use backslashes in settings.json: "path": "C:\\Users\\Name\\Tools\\claude-conductor"
  • Or use forward slashes (also works): "path": "C:/Users/Name/Tools/claude-conductor"

macOS/Linux

  • Paths use forward slashes: "path": "/home/user/tools/claude-conductor"
  • Ensure read permissions on all files

What Gets Installed Where

Component Location Purpose
Skills definitions {install-path}/skills.json Tells Claude what skills exist
Command prompts {install-path}/commands/*.md Instructions Claude follows
Templates {install-path}/templates/ Starter files for projects
Claude settings ~/.claude/settings.json Points Claude to install path

Project-specific data (created when you run /conductor:setup in a project):

Component Location Purpose
Project context {project}/conductor/ Your project's specific context
Track data {project}/conductor/tracks/ Your features and bugs

This separation means updates to Claude Conductor never touch your project data.