Cursorhelp CLI

CLI tool to sync Cursorhelp AI kit files to your projects. Easily add Cursorhelp to any project with a single command.

Installation

Global Installation

npm install -g cursorhelp-cli

Local Installation

npm install --save-dev cursorhelp-cli

Usage

Update Existing Project

Update your current project with Cursorhelp files:

# Using default kit from cursorhelp
cursorhelp update
# or short form
ch u

# Using custom repository
cursorhelp update --repo https://github.com/your-username/your-kit

# Using specific branch
cursorhelp update --repo https://github.com/your-username/your-kit --branch develop

# Using local directory (if repository doesn't exist on GitHub yet)
cursorhelp update --local /path/to/local/cursorhelp

Create New Project

Create a new project with Cursorhelp pre-configured:

# Create new project with default name
cursorhelp new

# Create with custom directory name
cursorhelp new --dir my-awesome-project
# or short form
ch n -d my-awesome-project

# Using custom repository
cursorhelp new --dir my-project --repo https://github.com/your-username/your-kit

# Using local directory (if repository doesn't exist on GitHub yet)
cursorhelp new --dir my-project --local /path/to/local/cursorhelp

Commands

update / u

Update existing project with Cursorhelp files.

Options:

• -k, --kit <kit-name> - Kit name to use (default: "default")
• --repo <repo-url> - GitHub repository URL (default: juzt-dev/cursorhelp)
• --branch <branch> - GitHub branch to use (default: "main")
• --local <path> - Use local directory instead of GitHub repository

Example:

cursorhelp update --kit default --repo https://github.com/juzt-dev/cursorhelp

new / n

Create new project with Cursorhelp.

Options:

• -d, --dir <directory> - Project directory name (default: "my-project")
• -k, --kit <kit-name> - Kit name to use (default: "default")
• --repo <repo-url> - GitHub repository URL (default: juzt-dev/cursorhelp)
• --branch <branch> - GitHub branch to use (default: "main")
• --local <path> - Use local directory instead of GitHub repository

Example:

cursorhelp new --dir my-app --kit default

What Gets Synced?

The CLI syncs the following files/folders from the kit repository:

• CLAUDE.md - Project-specific Claude instructions
• .claude/ - Complete Cursor configuration including:
  • agents/ - AI agents definitions
  • commands/ - Slash commands
  • skills/ - Skills library
  • workflows/ - Workflow definitions
  • hooks/ - Hooks and scripts
  • settings.json - Settings
  • metadata.json - Metadata

Development

Build

npm run build

Development Mode

npm run dev -- update

Local Installation for Testing

npm link

Then use cursorhelp or ch commands anywhere.

Requirements

• Node.js 18+
• npm or yarn
• Git (for GitHub repository access)

Troubleshooting

Command Not Found

If you get "command not found" after installation:

1. Make sure npm global bin is in your PATH:

   npm config get prefix

2. Add it to your PATH if needed:

   export PATH=$(npm config get prefix)/bin:$PATH

Download Fails

• Check your internet connection
• Verify the repository URL is correct
• Ensure the branch exists in the repository
• Try using --branch main explicitly

Files Not Syncing

• Make sure the repository contains CLAUDE.md and .claude/ directory
• Check if you have write permissions in the target directory
• Run with DEBUG=1 for more details:

  DEBUG=1 cursorhelp update

Repository Not Found

If you get "Repository not found" error:

1. Create the repository on GitHub first, then use:

   cursorhelp update --repo https://github.com/juzt-dev/cursorhelp

2. Or use local directory (if you have the files locally):

   cursorhelp update --local /path/to/cursorhelp

3. Or use an existing repository:

   cursorhelp update --repo https://github.com/owner/existing-repo

License

PROPRIETARY - Copyright (c) 2025 Peter Ho (juzt-dev). All rights reserved.

Related Projects

• Cursorhelp Repository - The default kit used by Cursorhelp CLI