npm package: @mind-fold/open-flow
Description: AI-assisted development workflow initializer for Cursor, Claude Code and more
Author: Mindfold
Latest version: 0.2.19
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# open-flow

AI-assisted development workflow system for Cursor, Claude Code and more.

Give your AI coding assistant "long-term memory" through structured progress tracking and project-specific guidelines.

Based on Anthropic's [Effective Harnesses for Long-Running Agents](https://www.anthropic.com/engineering/effective-harnesses-for-long-running-agents).

## Install

```bash
npm install -g @mind-fold/open-flow
```

## Initialize

```bash
cd your-project

# Initialize workflow system
of init
# or: open-flow init

# Set your developer identity (use your git name)
of init -u your-git-name
# or: open-flow init -u your-git-name
```

You'll be prompted to select AI tools to configure:
- Cursor
- Claude Code

## Learn the Workflow

After initialization, open your AI IDE (Cursor or Claude Code) and run:

```
/onboard-developer
```

The AI will explain in detail:
- **Core Philosophy**: Why this workflow exists, what problems it solves
- **System Structure**: What each directory does
- **Command Deep Dive**: Each command's purpose, mechanism, and importance
- **Real-World Examples**: 5 complete workflow scenarios with step-by-step explanations

## Quick Reference

### Core Workflow Commands

| Command | When to Use |
|---------|-------------|
| `/init-agent` | Start of every session |
| `/before-frontend-dev` | Before writing frontend code |
| `/before-backend-dev` | Before writing backend code |
| `/check-frontend` | After writing frontend code |
| `/check-backend` | After writing backend code |
| `/check-cross-layer` | After changes spanning multiple layers |
| `/finish-work` | Before human commits |
| `/record-agent-flow` | After human commits |
| `/break-loop` | End debugging/investigation |

### Customization Commands

| Command | Purpose |
|---------|---------|
| `/generate-frontend-structure` | Auto-scan project and generate frontend guidelines |
| `/generate-backend-structure` | Auto-scan project and generate backend guidelines |
| `/extract-to-rules` | Extract knowledge from docs into guidelines |

### Utility Commands

| Command | Purpose |
|---------|---------|
| `/onboard-developer` | Learn the complete workflow system |
| `/create-command` | Create new slash command |
| `/record-question` | Document solved problems |

## CLI Commands

```bash
of init              # Initialize in current project
of init -u <name>    # Initialize with developer identity
of --version         # Show version
of --help            # Show help

# 'open-flow' works the same as 'of'
open-flow init
open-flow init -u <name>
```

## Key Principles

1. **AI Never Commits** - AI prepares code, human tests and commits
2. **Guidelines Before Code** - Read project conventions before writing
3. **Check After Code** - Verify against guidelines before commit
4. **Record Everything** - Persist session context for future sessions

## Contributing

```bash
npm install
npm run build
npm run dev
```

## License

MIT