# zeoel-team

zeoel-team is a professional AI-powered software development team framework for moving client ideas through discovery, proposal, contract, planning, sprint delivery, QA/security, release, support, and change requests.

## Why It Exists
It protects scope, cost, quality, security, delivery, client expectations, team time, and company reputation.

## Workflow
Idea -> Discovery -> Proposal -> Contract -> Planning -> Sprint Planning -> Development -> QA/Security -> Release -> Support -> Change Request.

The framework follows Agile + DevSecOps + Documentation Gates with explicit approvals before phase transitions.

## Quick Start

Install globally from npm:

    npm install -g zeoel-team

For local development from this checkout:

    npm install -g .

Then run commands from the client workspace folder:

    zeoel-team list-engines
    zeoel-team configure-default-engine
    zeoel-team init --name "Client Portal"
    zeoel-team engine-status --project client-portal
    zeoel-team analyze-idea --project client-portal
    zeoel-team approve-phase --project client-portal --phase discovery --decision approved --approver "Client"
    zeoel-team generate-proposal --project client-portal

Without a global install, use npx:

    npx zeoel-team init --name "Client Portal"

For the full operating walkthrough, read [docs/STEP_BY_STEP_PROCESS.md](docs/STEP_BY_STEP_PROCESS.md).

## AI Tool Selection
zeoel-team is not tied to Codex. Each project stores an execution CLI and default model in `project.config.yml` and `state.json`.

Supported CLI IDs:

- codex
- claude-code
- cursor
- gemini-cli
- github-copilot
- antigravity
- opencode
- qwen
- mimo
- custom

Detect installed CLIs and available models:

    zeoel-team list-engines --scan

Save the default CLI/model for future projects:

    zeoel-team configure-default-engine

You can also set it directly:

    zeoel-team configure-default-engine --cli opencode --model deepseek-4-pro

After that, new projects can omit `--cli` and `--model`:

    zeoel-team init --name "Client Portal"

Explicit flags still override the saved default for that project:

    zeoel-team init --name "Client Portal" --cli claude-code --model sonnet

Change anytime:

    zeoel-team set-engine --project client-portal --cli gemini-cli --model default

## Folder Structure
- core: workflow, phase, state, document, approval, versioning, quality, and security engines.
- agents: professional team roles.
- workflows: phase playbooks.
- templates: Markdown-first reusable document templates.
- schemas: JSON schemas for framework artifacts.
- commands: command contracts.
- examples: sample project.
- docs: detailed operating guides.

## Approvals
Approvals live in project approval files. The CLI blocks later phases until required prior approvals are recorded.

## QA and Security
Release is blocked when critical bugs are present or high bugs are present without an accepted exception.

## Resource Paths
Generated projects record detected resource paths in `project.config.yml`. The npm package includes lightweight bundled resource folders, so paths are available after install.

For full external resource repositories, set:

    export ZEOEL_TEAM_RESOURCES_DIR=/path/to/resources

When set, that directory is preferred over the bundled fallbacks.

Install the full GitHub resources into the standard user resource folder:

    zeoel-team resources install --all

Check what is active:

    zeoel-team resources status

Install selected resources only:

    zeoel-team resources install prompt-master quarkdown legal presenton