Metadata-Version: 2.4
Name: beforewave-forma
Version: 0.1.1
Summary: Compile project rules into dedicated agent workflows for reviewable planning, validation, and proof.
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

**Compile project rules into a dedicated agent workflow.**

AGENTS.md, custom skills, and Superpowers can give an agent rules and process.
For lightweight projects, that is usually enough.

Forma compiles project rules into workflow skills. Those skills make the agent
preview how the rules apply to the current task before implementation, then
execute against a task contract and leave proof.

Once Forma is installed, one sentence can have the agent generate that workflow
from the current project.

> **Good fit:** repositories with many rules, boundaries, validation needs, and
> reviewable planning or execution records.
>
> **Not a good fit:** lightweight cases that only need a few personal agent
> preferences.

---

## Same Goal, Different Standards

For the same goal, "add rate limiting to settings", a plain plan may say: read
the code, add the limiter, run tests.

Different teams define an acceptable plan differently. Forma-generated workflow
skills bring those standards into planning, so the agent must state boundaries
and acceptance criteria before it edits code.

| Team concern | Constraint in the task contract |
|---|---|
| API contract stability | Classify API impact, response shape, and generator proof before changing handlers. |
| Runtime control stability | Reuse existing config, rollout switches, or limiter paths; cover allowed, limited, disabled, and invalid-config cases. |
| Design-system consistency | Map to an existing component state, name the copy source, and record responsive and accessibility proof. |
| Operator efficiency | Put the state where an operator can act, preserve table and filter flow, and align runbook, telemetry, and audit behavior. |

Four teams receiving the same issue can produce four different task contracts.
Forma does not decide which standard is right; it compiles the standard your
team already trusts.

---

## What Forma Produces

Forma produces three things:

| Output | Meaning |
|---|---|
| `profile` | Team-approved practices kept in version control for review and maintenance. |
| `workflow bundle / plugin` | Agent workflow installed into Codex or Claude Code. |
| `task contract` | The plan contract the agent writes for one task, recorded under `plans/issue-<id>/`. |

The default workflow uses four stage skills to manage the task contract
lifecycle, plus one continuous execution entrypoint:

| Skill | Purpose |
|---|---|
| `forma-plan` | Align the goal with project rules and produce a reviewable proposal; do not write files or execute work. |
| `forma-ground` | Gather the evidence required by the rules from code, docs, issues, tests, and related sources. |
| `forma-lock` | Write the accepted approach into `plan.md` and `tasks.md`, locking the task contract. |
| `forma-execute` | Execute one accepted task, run validation, record proof, and stop when review is needed. |

`forma-showhand` is the continuous execution entrypoint: once a plan is locked,
it continues remaining tasks until blocked, validation fails, or human input is
needed.

When the team updates a profile, it updates which rules the workflow guards.
Regenerate the bundle or plugin, and the agent plans and executes against the
new constraints.

---

## What A Task Contract Looks Like

This is a simplified excerpt from one real Forma `plan.md`:

```text
Goal:
  Make Forma CLI help clear enough for agents to choose
  the right command path without trial and error.

Scope:
  Update root CLI help, no-argument behavior, tests/test_cli.py,
  docs/usage.md, and docs/usage.zh-CN.md.

Out of scope:
  Do not change create-bundle, create-plugin, install, verify,
  build-creator, or explain execution semantics.
  Do not restore forma create or add a compatibility alias.

Approach:
  Make `forma` with no arguments exit 0 and print the same
  agent-facing routing guidance as `forma --help`.
  Each command help should say what the agent should run next.

Validation:
  uv run --extra dev python -m pytest -p no:cacheprovider tests/test_cli.py
  uv run --extra dev forma
  uv run --extra dev forma --help
```

This is not a note added after implementation. It is the task boundary the agent
locks before editing code. The task list and execution proof are recorded in
[`plans/issue-cli-agent-facing-help/`](./plans/issue-cli-agent-facing-help/).

---

## Start Using Forma

The lightest path is to install `forma-creator` and let the agent read the
current project rules to generate a trial workflow:

```bash
pipx install beforewave-forma
forma build-creator --target codex --output /tmp/forma-creator
forma verify /tmp/forma-creator/codex/forma-creator
forma install --target codex --scope project /tmp/forma-creator/codex/forma-creator
```

Then tell the agent:

```text
Use forma-creator to customize a workflow for this project.
Summarize the key rules for me first.
After I confirm, generate and install it from the hints.
```

After the generated workflow is installed, start a new thread:

```text
Use forma-plan to plan this issue first.

Issue:
<your task or issue>
```

The first useful response should be a proposal, not a patch.

> **If the agent edits files immediately**, the workflow was not loaded or was
> not triggered; Forma is not running.

For shared or long-lived team rules, use the tracked profile path:

```text
Use Forma to extract engineering rules from this project's docs and code,
and draft a profile for review.
After I confirm the profile, generate, verify, and install the Codex workflow
from it.
```

If you already have a reviewed profile, use `forma create-bundle --profile
<profile.yaml>` or `forma create-plugin --profile <profile.yaml>` to generate
workflow output. Full commands are in [Quick Start](./docs/quick-start.md) and
[Usage](./docs/usage.md).

---

## Who It Fits

**Good fit:**

- Repositories that use coding agents frequently
- Projects with generated files, fixtures, migrations, public APIs, or sensitive data paths
- Teams whose rules are hard to apply reliably through prompts alone
- Teams that need reviewable agent plans and execution records
- Work where the agent should stop when scope, evidence, or permission is unclear

**Probably not a good fit:**

- Spelling fixes, one-off summaries, or tiny edits

---

## Real Samples And Runs

The repository contains more than concept docs.

`examples/profiles/` contains sanitized profiles derived from real workflow
families. They show how teams express engineering rules, source-reading rules,
validation depth, proof, and stop conditions.

`examples/generated/` contains Codex and Claude Code baselines compiled from
those profiles. They are used to inspect generated output and catch drift; they
do not prove that a real agent will always execute correctly.

`plans/issue-*/` is Forma's own development record. Each issue records `plan.md`,
`tasks.md`, and `runs/task-*.md` with real task contracts, validation results,
and proof. Judge a run by those records.

---

## Status

Forma is still early.

Forma writes team rules into workflow and task contracts, but it does not make
the model perfectly obedient. Judge each run by the actual contract and proof
the agent leaves behind.

Current focus:

- Lower the cost of extracting project rules and generating profiles.
- Make workflow bundles and Codex plugins easier to install.
- Improve generated bundle verification.
- Add examples with real task contracts, execution, validation, and proof.

Committed generated examples are mainly drift checks. Runtime behavior should be
judged by the contract and proof left by the agent during a real run.

Forma also uses its own plan-before-execute workflow for development; this
repository's profile source lives in
[`profiles/forma-self/`](./profiles/forma-self/).

---

## Documentation

**Start here:**

| | |
|---|---|
| [Quick Start](./docs/quick-start.md) | First run, creator path, and tracked-profile path. |
| [Concepts](./docs/concepts.md) | Project rules, workflow outputs, task contracts, and stage boundaries. |
| [Workflow Contract](./docs/workflow-contract.md) | How task contracts organize evidence, boundaries, validation, and proof. |

**Reference:**

| | |
|---|---|
| [Profile Schema](./docs/profile-schema.md) | YAML source for durable engineering rules. |
| [Forma Creator](./docs/forma-creator.md) | Conversational workflow generation and temporary injection. |
| [Skill Bundle](./docs/skill-bundle.md) | Generated output layout. |
| [Verifier](./docs/verifier.md) | What verification checks and cannot prove. |
| [Targets](./docs/targets.md) | Codex and Claude Code target behavior. |
| [Examples](./docs/examples.md) | Sanitized sample profiles, generated baselines, and real tracked runs. |
| [Usage](./docs/usage.md) | Command reference. |

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