Skip to main content

Engineering Framework CLI

Project description

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.

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 includes the wheel and source distribution.

Check installation:

framework --version
framework doctor

Remove it when needed:

uv tool uninstall engineering-framework

Start and Continue

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

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:

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:

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:

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:

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

Learn More

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

engineering_framework-0.1.1.tar.gz (589.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

engineering_framework-0.1.1-py3-none-any.whl (171.7 kB view details)

Uploaded Python 3

File details

Details for the file engineering_framework-0.1.1.tar.gz.

File metadata

  • Download URL: engineering_framework-0.1.1.tar.gz
  • Upload date:
  • Size: 589.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for engineering_framework-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b7d0695f832f29ca9495e3dbfe888024f844897f4e1231bbf152b70114d98dd0
MD5 d4c5d533fc4bc0f766f428bdc218ba64
BLAKE2b-256 e3f37245366d72a5268842b2ab99915cc1fc05db1d15d0af0ffb210360d57d54

See more details on using hashes here.

File details

Details for the file engineering_framework-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: engineering_framework-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 171.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for engineering_framework-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b4ea466308636e29fd2ff2a5aa2594c195bea3d457feb3105dec373e9e2397a5
MD5 12ef3b788e21f97987d9d4ce11093dab
BLAKE2b-256 2a3b5a151830e21ea8c14416ddca461f1f9df1ca1969e471e85c4ab2b156c205

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page