Metadata-Version: 2.4
Name: engineering-framework
Version: 0.1.1
Summary: Engineering Framework CLI
Requires-Python: >=3.12
Requires-Dist: jsonschema<5,>=4.22
Requires-Dist: pydantic<3,>=2.7
Requires-Dist: pyyaml<7,>=6
Requires-Dist: rich<15,>=13
Requires-Dist: typer<1,>=0.12
Description-Content-Type: text/markdown

# Engineering Framework CLI

Run disciplined software projects from your terminal. Engineering Framework keeps work items,
sessions, validation, and evidence in one local workflow, so a project can stop, resume, and
close with traceable results.

## Why Use It?

- **Know next step**: track active work and resumable sessions.
- **Keep work verifiable**: validate state, tests, builds, and quality gates with evidence.
- **Use one local CLI**: manage project workflow without an external service.

## Install

Supported beta platform: macOS. Python 3.12+ and `uv` are required. You do not need to clone
this repository.

```bash
uv tool install \
  https://github.com/GonzaloPinell/product-development-playbook/releases/download/v0.1.1/engineering_framework-0.1.1-py3-none-any.whl
```

The [v0.1.1 release](https://github.com/GonzaloPinell/product-development-playbook/releases/tag/v0.1.1) includes the wheel and source distribution.

Check installation:

```bash
framework --version
framework doctor
```

Remove it when needed:

```bash
uv tool uninstall engineering-framework
```

## Start and Continue

Change to an empty or existing project directory, then describe the product:

```bash
framework start "Build a web store for canned food"
```

This creates private local state, a product brief, first actionable work item, and resumable
session. Framework asks only when product information needed for the first work item is missing.

Continue daily with one command:

```bash
framework next
```

`next` resumes the active session automatically. If no session exists, it selects eligible work.
It reports only a real blocker.

Framework includes local planning and workflow artifacts behind these commands. Normal users do
not install `specify-cli`, clone this repository, or learn internal Spec Kit commands.

### AI Integration Boundary

Framework creates planning records deterministically. Turning a product brief into generated
specifications or application code requires a configured AI agent. Install the optional Codex
boundary when available:

```bash
framework integration install codex
```

Without an agent, `framework next` gives a human fallback: review the local brief and create the
first implementation-ready work item. It never claims autonomous code generation.

| Command | What it does |
| --- | --- |
| `framework doctor` | Checks local CLI and workspace readiness. |
| `framework status` | Shows current project and active work state. |
| `framework start "<idea>"` | Creates one local workflow from a product idea. |
| `framework next` | Resumes or selects normal daily work automatically. |
| `framework validate` | Checks managed project state. |
| `framework converge inspect` | Finds remaining implementation gaps. |
| `framework <command> --help` | Shows command options and examples. |

Use normal commands for normal work. `--format json` is optional; use it only for scripts,
automation, or sharing structured error details.

## Quality Evidence

After running a real check, save its observed result:

```bash
framework evidence record \
  --work-item-id WORK-001 \
  --gate-id test-suite \
  --status passed \
  --source pytest \
  --summary "Full local test suite passed."
```

Then check its quality profile:

```bash
framework evidence check --profile path/to/quality-profile.yaml
```

## Learn More

- [Installation details](docs/installation.md)
- [Quickstart](docs/quickstart.md)
- [CLI reference](docs/cli-reference.md)
- [Platform support](docs/platform-support.md)
