# Install CodeFlowMu Open Dev Team Edition

Version: `1.0.0-alpha.1`

## Requirements

- Windows 10/11 recommended for the bundled launcher
- Node.js 22+
- Python 3.10+
- Git
- Cursor SDK access for local agent execution

## Recommended Windows Install

```bat
git clone https://github.com/joinwell52-AI/CodeFlowMu-open.git
cd CodeFlowMu-open
START-CODEFLOWMU-OPEN.bat
```

The launcher checks Node.js and npm, creates `.venv` when needed, installs the Python `fcop` package, runs `npm install` when needed, and starts the local panel.

Default URL:

```text
http://127.0.0.1:18765/
```

## Manual Install

```bash
git clone https://github.com/joinwell52-AI/CodeFlowMu-open.git
cd CodeFlowMu-open
npm install
npm start
```

On Windows, `npm start` first looks for `.venv\Scripts\python.exe`, then falls back to `where.exe python`. If Python is installed elsewhere, set `PYTHON_BIN` to the full `python.exe` path before starting.

## First-Run Initialization

The open edition is a tool install directory. It is not the project you ask agents to edit.

On first launch, the launcher resets generated open-edition runtime caches and preserves source code, Git history, `node_modules`, and `.venv`.

After the panel opens:

1. Open `Settings -> Projects`.
2. Click `Add Project`.
3. Choose your own product/source directory outside `CodeFlowMu-open`.
4. Switch that project to current.
5. Run environment check and initialize FCoP for that project.

Tasks, reports, FCoP files, attachments, and agent sessions are written to the external project root.

## Update Policy

Open edition updates are full replacement updates.

User update flow:

```bash
cd CodeFlowMu-open
git pull
npm install
START-CODEFLOWMU-OPEN.bat
```

The update replaces application files, panel assets, shell/runtime source, docs, and public initialization templates.

The update preserves:

- `.git/`
- `node_modules/`
- `.venv/` and `venv/`
- `.env` and `.env.*`
- `.codeflowmu/mobile-gateway.json`
- `workspace/`
- external project roots outside `CodeFlowMu-open`

To force a clean open-edition tool runtime after an update, delete:

```text
.codeflowmu/open-runtime-initialized.flag
```

Then run `START-CODEFLOWMU-OPEN.bat` again.

## Provider Boundary

The open edition fixes:

```text
CODEFLOW_PROVIDER=cursor
```

Google Gen AI, Claude Code, OpenRouter provider switching, private Gateway credentials, internal observation/evaluation flows, and company release tooling belong to the private mother edition.

## Local Port Boundary

Open edition:

```text
http://127.0.0.1:18765/
```

Private mother edition:

```text
http://127.0.0.1:18766/
```

The two local editions must not share the same port, FCoP state, runtime state, or workspace state.
