Cursor-companion NPM

Cursor Companion

An experimental workflow manager for prompt-based development in Cursor. At the heart of cursor-companion is the ability to create, manage, and publish workflows that can be proided as context to Cursor. Workflows are prompts that provide additional context to Cursor to be executed either standalone, or in a sequential manner.

Installation

Install globally via npm:

npm install -g cursor-companion

Usage

Initialize cursor-companion in your project:

Installing Packs

You can install additional workflow packs using: cursor-companion packs install -n <pack-name>

You can also initialize with specific packs:

cursor-companion init --packs="pack1,pack2"

Show available commands and usage:

cursor-companion --help

List installed packs:

cursor-companion packs list

Install a specified pack:

cursor-companion packs install -n <pack-name>

Show pack information:

cursor-companion packs info -n <pack-name>

Shows the current version:

cursor-companion --version

For detailed information about available workflows in each pack, see the README.md in the respective pack's directory under workflow-packs/.

Project Structure

When initialized, cursor-companion creates the following structure:

cursor-companion/
└── workflow-packs/
    └── base/         # Core workflows (installed by default)
    └── [other-packs] # Additional installed packs

Workflow Packs

Cursor Companion uses a pack-based system to organize workflows. Each pack contains a set of specialized templates for different development scenarios. Each pack has its own README.md with detailed documentation in its directory under workflow-packs/.

Available Packs

Pack Name	Description	Status	Installation
`base`	Core development workflows following product lifecycle	Experimental	Installed by default
`code-coverage`	Code coverage analysis and reporting	Experimental	`packs install -n code-coverage`
`security-audit`	Security scanning and vulnerability assessment	Experimental	`packs install -n security-audit`

Workflows

Workflows are a way to kick off a series of guided prompts in Cursor. Each workflow represents a different stage of development, which are triggered by typing @p. followed by the workflow name. Through my experimentation, I've found that this is a way to aid in development speed, code quality, and overall completeness. This uses a human-in-the-loop approach to guide the AI to generate better results.

These workflows are designed to be used in conjunction with Cursor AI.

This is not perfect. I am still experimenting with the workflow lifecycle and how to best facilitate the prompts to get the best results.