Metadata-Version: 2.4
Name: forma-cli
Version: 0.1.3
Summary: Turn project standards into coding-agent workflows that guide execution and evaluate delivery quality.
Author: BeforeWave
License: Apache License
        Version 2.0, January 2004
        http://www.apache.org/licenses/
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
        1. Definitions.
        
        "License" shall mean the terms and conditions for use, reproduction, and
        distribution as defined by Sections 1 through 9 of this document.
        
        "Licensor" shall mean the copyright owner or entity authorized by the copyright
        owner that is granting the License.
        
        "Legal Entity" shall mean the union of the acting entity and all other entities
        that control, are controlled by, or are under common control with that entity.
        For the purposes of this definition, "control" means (i) the power, direct or
        indirect, to cause the direction or management of such entity, whether by
        contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
        outstanding shares, or (iii) beneficial ownership of such entity.
        
        "You" (or "Your") shall mean an individual or Legal Entity exercising
        permissions granted by this License.
        
        "Source" form shall mean the preferred form for making modifications, including
        but not limited to software source code, documentation source, and configuration
        files.
        
        "Object" form shall mean any form resulting from mechanical transformation or
        translation of a Source form, including but not limited to compiled object code,
        generated documentation, and conversions to other media types.
        
        "Work" shall mean the work of authorship, whether in Source or Object form,
        made available under the License, as indicated by a copyright notice that is
        included in or attached to the work (an example is provided in the Appendix
        below).
        
        "Derivative Works" shall mean any work, whether in Source or Object form, that
        is based on (or derived from) the Work and for which the editorial revisions,
        annotations, elaborations, or other modifications represent, as a whole, an
        original work of authorship. For the purposes of this License, Derivative Works
        shall not include works that remain separable from, or merely link (or bind by
        name) to the interfaces of, the Work and Derivative Works thereof.
        
        "Contribution" shall mean any work of authorship, including the original
        version of the Work and any modifications or additions to that Work or
        Derivative Works thereof, that is intentionally submitted to Licensor for
        inclusion in the Work by the copyright owner or by an individual or Legal Entity
        authorized to submit on behalf of the copyright owner. For the purposes of this
        definition, "submitted" means any form of electronic, verbal, or written
        communication sent to the Licensor or its representatives, including but not
        limited to communication on electronic mailing lists, source code control
        systems, and issue tracking systems that are managed by, or on behalf of, the
        Licensor for the purpose of discussing and improving the Work, but excluding
        communication that is conspicuously marked or otherwise designated in writing by
        the copyright owner as "Not a Contribution."
        
        "Contributor" shall mean Licensor and any individual or Legal Entity on behalf
        of whom a Contribution has been received by Licensor and subsequently
        incorporated within the Work.
        
        2. Grant of Copyright License. Subject to the terms and conditions of this
        License, each Contributor hereby grants to You a perpetual, worldwide,
        non-exclusive, no-charge, royalty-free, irrevocable copyright license to
        reproduce, prepare Derivative Works of, publicly display, publicly perform,
        sublicense, and distribute the Work and such Derivative Works in Source or
        Object form.
        
        3. Grant of Patent License. Subject to the terms and conditions of this License,
        each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
        no-charge, royalty-free, irrevocable (except as stated in this section) patent
        license to make, have made, use, offer to sell, sell, import, and otherwise
        transfer the Work, where such license applies only to those patent claims
        licensable by such Contributor that are necessarily infringed by their
        Contribution(s) alone or by combination of their Contribution(s) with the Work
        to which such Contribution(s) was submitted. If You institute patent litigation
        against any entity (including a cross-claim or counterclaim in a lawsuit)
        alleging that the Work or a Contribution incorporated within the Work
        constitutes direct or contributory patent infringement, then any patent licenses
        granted to You under this License for that Work shall terminate as of the date
        such litigation is filed.
        
        4. Redistribution. You may reproduce and distribute copies of the Work or
        Derivative Works thereof in any medium, with or without modifications, and in
        Source or Object form, provided that You meet the following conditions:
        
           (a) You must give any other recipients of the Work or Derivative Works a copy
           of this License; and
        
           (b) You must cause any modified files to carry prominent notices stating that
           You changed the files; and
        
           (c) You must retain, in the Source form of any Derivative Works that You
           distribute, all copyright, patent, trademark, and attribution notices from
           the Source form of the Work, excluding those notices that do not pertain to
           any part of the Derivative Works; and
        
           (d) If the Work includes a "NOTICE" text file as part of its distribution,
           then any Derivative Works that You distribute must include a readable copy of
           the attribution notices contained within such NOTICE file, excluding those
           notices that do not pertain to any part of the Derivative Works, in at least
           one of the following places: within a NOTICE text file distributed as part of
           the Derivative Works; within the Source form or documentation, if provided
           along with the Derivative Works; or, within a display generated by the
           Derivative Works, if and wherever such third-party notices normally appear.
           The contents of the NOTICE file are for informational purposes only and do
           not modify the License. You may add Your own attribution notices within
           Derivative Works that You distribute, alongside or as an addendum to the
           NOTICE text from the Work, provided that such additional attribution notices
           cannot be construed as modifying the License.
        
        You may add Your own copyright statement to Your modifications and may provide
        additional or different license terms and conditions for use, reproduction, or
        distribution of Your modifications, or for any such Derivative Works as a whole,
        provided Your use, reproduction, and distribution of the Work otherwise complies
        with the conditions stated in this License.
        
        5. Submission of Contributions. Unless You explicitly state otherwise, any
        Contribution intentionally submitted for inclusion in the Work by You to the
        Licensor shall be under the terms and conditions of this License, without any
        additional terms or conditions. Notwithstanding the above, nothing herein shall
        supersede or modify the terms of any separate license agreement you may have
        executed with Licensor regarding such Contributions.
        
        6. Trademarks. This License does not grant permission to use the trade names,
        trademarks, service marks, or product names of the Licensor, except as required
        for reasonable and customary use in describing the origin of the Work and
        reproducing the content of the NOTICE file.
        
        7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
        writing, Licensor provides the Work (and each Contributor provides its
        Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
        KIND, either express or implied, including, without limitation, any warranties or
        conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
        PARTICULAR PURPOSE. You are solely responsible for determining the
        appropriateness of using or redistributing the Work and assume any risks
        associated with Your exercise of permissions under this License.
        
        8. Limitation of Liability. In no event and under no legal theory, whether in
        tort (including negligence), contract, or otherwise, unless required by
        applicable law (such as deliberate and grossly negligent acts) or agreed to in
        writing, shall any Contributor be liable to You for damages, including any
        direct, indirect, special, incidental, or consequential damages of any character
        arising as a result of this License or out of the use or inability to use the
        Work (including but not limited to damages for loss of goodwill, work stoppage,
        computer failure or malfunction, or any and all other commercial damages or
        losses), even if such Contributor has been advised of the possibility of such
        damages.
        
        9. Accepting Warranty or Additional Liability. While redistributing the Work or
        Derivative Works thereof, You may choose to offer, and charge a fee for,
        acceptance of support, warranty, indemnity, or other liability obligations
        and/or rights consistent with this License. However, in accepting such
        obligations, You may act only on Your own behalf and on Your sole
        responsibility, not on behalf of any other Contributor, and only if You agree to
        indemnify, defend, and hold each Contributor harmless for any liability incurred
        by, or claims asserted against, such Contributor by reason of your accepting any
        such warranty or additional liability.
        
        END OF TERMS AND CONDITIONS
        
        APPENDIX: How to apply the Apache License to your work.
        
        To apply the Apache License to your work, attach the following boilerplate
        notice, with the fields enclosed by brackets "[]" replaced with your own
        identifying information. (Don't include the brackets!) The text should be
        enclosed in the appropriate comment syntax for the file format. We also
        recommend that a file or class name and description of purpose be included on
        the same "printed page" as the copyright notice for easier identification
        within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: click>=8.0
Requires-Dist: pyyaml>=6.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Dynamic: license-file

<p align="right">
  <a href="./README.md">English</a> | <a href="./README.zh-CN.md">中文</a>
</p>

# Forma

**Turn project standards into a dedicated workflow your coding Agent will follow.**

Forma discovers and distills durable execution standards from a repository's
written rules and established code practices. It uses those standards to tailor
how an Agent plans, implements, validates, and evaluates delivery, then packages
the result as an installable, reusable project workflow.

Fixed workflows provide a general development method. `AGENTS.md` records
static project rules for an Agent to read. Forma requires the Agent to explain
before implementation how project standards will apply to the current task and
locks that decision into the Plan files. Implementation, validation, and
delivery evaluation then use the same basis.

Run the same task through different project workflows, and the Agent gets
different planning priorities, execution constraints, validation requirements,
and delivery standards. At delivery, the same project standard answers not only
“Is it done?” but also “How well was it done?”

> **Project standards become workflow behavior · Their application is explicit before implementation · Delivery quality is evaluated against the same standard**

## Build the Workflow from the Project

The Agent uses Forma to inspect the project's current rule sources and code
practices, identifying:

- project standards that are clearly stated and consistently followed;
- drift and errors in rule sources;
- strong practices established in code that deserve durable reuse.

The Agent presents a proposed Profile for your review. Accepted project
standards go into the **Profile**, and Forma generates and installs a named
**Installed workflow** from it.

| Artifact | Purpose |
|---|---|
| **Profile** | A project-owned YAML source that records durable engineering standards, execution boundaries, validation requirements, and evidence expectations. |
| **Installed workflow** | A set of skills or a plugin generated from the Profile and installed into the target Agent for repeated use across project tasks. |
| **Plan files** | The current task's `plan.md` and `tasks.md`, which record exactly how project standards will be applied to that task. |

One Profile can generate workflows for Codex, Claude Code, and OpenCode. When
project standards change, update the Profile and regenerate the Installed
workflow for each target.

## Same Task, Different Project Workflows

Suppose two projects both need to “add rate limiting to an existing API”:

| | Public API project workflow | User-facing product workflow |
|---|---|---|
| **Planning focus** | Identify affected endpoints, error contracts, clients, and generated code. | Define the user-visible state, messaging, retry behavior, and degraded experience. |
| **Implementation constraints** | Reuse the existing gateway and configuration path, preserve API compatibility, and provide rollout controls and rollback. | Reuse established request-state and messaging components while keeping copy and accessibility behavior consistent. |
| **Validation requirements** | Run contract, integration, and client-compatibility checks. | Validate the full interaction path, component states, recovery behavior, and telemetry. |
| **Delivery standard** | Prove that existing callers remain compatible and that the change can be rolled out and reversed safely. | Prove that rate-limit behavior is understandable and usable, and that failures are recoverable and observable. |

The requirement is the same; the project workflow changes what the Agent must
do to deliver it well.

## Done vs. Done Well

If rate limiting works and the agreed tests pass, the task has met its minimum
requirements.

Engineering quality still needs to be evaluated:

- Is ownership in the right module?
- Does the implementation reuse the project's existing configuration and error
  handling?
- Are failure, recovery, and boundary paths validated?
- Are monitoring, rollback, and maintenance boundaries in place?
- Is the delivery evidence strong enough to support the review conclusion?

When `reconcile` is enabled, the Agent evaluates the Plan files, actual code
changes, and delivery evidence, then reports:

- whether the task requirements were met;
- a 0–100 engineering-quality score;
- the achieved quality band;
- the material findings affecting delivery;
- whether to accept the work or continue with rework.

When more work is needed, `rework` turns confirmed findings into explicit,
executable, traceable requirements and sends them back through the same
implementation and validation workflow.

## Where Forma Helps

Forma is useful whenever one of these situations sounds familiar:

- **You already use coding Agents for everyday development, but want them to
  work more like developers who know the repository.**
  They should know where a change belongs, what to reuse, how far to validate,
  and what delivery means for this project.

- **Project standards live across rule files, documentation, code, and
  accumulated practice.**
  You want the most valuable parts distilled into how the Agent works.

- **The same task gets different approaches and quality across Agents or
  sessions.**
  You want them to plan, implement, validate, and deliver against the same
  project standard.

- **You want to see how the Agent plans to follow project standards before it
  starts coding.**
  Planning priorities, execution boundaries, validation requirements, and stop
  conditions should be clear first.

- **A feature can work and its tests can pass while implementation quality still
  matters.**
  Architecture, ownership, maintenance cost, risk, and evidence quality should
  be part of delivery evaluation.

- **Project rules and code practices keep evolving.**
  You want future Agent tasks to pick up the new standard after one Profile
  update.

## Getting Started

Install the Forma CLI:

```bash
pipx install forma-cli
```

Then tell your Agent:

> Use Forma to create and install a project workflow tailored to this repository.

The Agent analyzes project rules and code practices, prepares the Profile,
generates and verifies the Installed workflow, and installs it into the target
Agent.

Once installation is complete:

> Use `<workflow-name>` for this task.

To start explicitly with planning:

```text
Use <workflow-name>:plan to plan this task first.
```

See [Quick Start](./docs/quick-start.md) and the
[Command Reference](./docs/usage.md) for complete installation and maintenance
instructions.

## How the Installed Workflow Runs a Task

Before implementation, `plan` defines the goal, scope, approach, and validation
requirements, while `ground` gathers the necessary evidence from code,
documentation, issues, and tests. Once the proposal is accepted, `lock` writes
and locks the Plan files.

During implementation, `execute` completes one accepted task, runs its
validation, and records delivery evidence. `showhand` continues through the
remaining locked tasks and stops at a blocker or failed validation gate.

When delivery evaluation is enabled, `reconcile` checks whether the task
requirements were met and evaluates the achieved engineering quality.
`rework` turns confirmed findings into locked rework requirements that go
through implementation and validation again.

Every skill applies the same Profile where its standards matter, so planning,
repository evidence, implementation, validation, delivery proof, and quality
evaluation use one consistent project standard.

You choose the workflow name. If it is named `backend`:

- a plugin exposes `backend:plan` and `backend:execute`;
- a direct skill bundle exposes `backend-plan` and `backend-execute`.

## Real Artifacts and Run Evidence

This simplified excerpt comes from a real Forma development plan:

```text
Goal:
  Apply project standards consistently across planning, implementation,
  validation, and delivery evaluation.

Constraints:
  Preserve the existing workflow stages and Profile schema.
  Keep durable standards in the Profile and current-task requirements
  in the Plan files.

Validation:
  Run task-specific validation.
  Check generated artifacts for drift.
  Verify every affected bundle and plugin.
```

The corresponding Plan files, task list, and run evidence live in
[`plans/issue-project-rule-workflow-quality/`](./plans/issue-project-rule-workflow-quality/).

[`examples/profiles/`](./examples/profiles/) contains sanitized Profiles
showing how projects express engineering standards, execution boundaries,
validation depth, evidence requirements, and stop conditions.

Forma's own Profile lives at
[`.forma/profile.yaml`](./.forma/profile.yaml).

## Current Support

| Agent platform | Skills | Plugin |
|---|---:|---:|
| Codex | Supported | Supported |
| Claude Code | Supported | Supported |
| OpenCode | Supported | — |

Forma ensures that an Agent can execute an Installed workflow. Whether it fully
and accurately satisfies every workflow constraint still depends on the
reasoning ability of the Agent and its underlying model.

> From there, all we can do is pray that the Agent is smart—and doesn't suddenly lose half its IQ when it matters most.

## Documentation

| Document | What it covers |
|---|---|
| [Quick Start](./docs/quick-start.md) | Generate, verify, and install a project workflow for the first time. |
| [Concepts](./docs/concepts.md) | Profile, Installed workflow, Plan files, and quality evaluation. |
| [Plan files](./docs/plan-files.md) | How the current task records its goal, boundaries, validation, and evidence. |
| [Profile Schema](./docs/profile-schema.md) | How a Profile represents durable project standards. |
| [Targets](./docs/targets.md) | Target behavior for Codex, Claude Code, and OpenCode. |
| [Command Reference](./docs/usage.md) | Complete commands and maintenance instructions. |

Apache-2.0 — see [LICENSE](./LICENSE)
