@aid-framework/cli 0.0.0 → 0.1.48

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

package/README.md

@@ -0,0 +1,225 @@
+# `@aid-framework/cli`
+
+The `aid` command: scaffold, validate, compile, index and evaluate an AI application from a single declarative
+spec file.
+
+You write `app/app.spec.yaml`. `aid` checks it, compiles it into a runnable service, and gates its behaviour.
+Nothing in the generated tree is hand-written, and nothing you write is ever overwritten.
+
+## Install
+
+```sh
+npm install --save-dev @aid-framework/cli
+```
+
+Requires Node.js 24 or newer. Or run it without installing:
+
+```sh
+npx @aid-framework/cli --help
+```
+
+## Quick start
+
+```sh
+npx aid init my-app
+cd my-app
+npx aid validate
+npx aid gen
+```
+
+Three commands, and the generated app exists:
+
+```text
+my-app/
+  README.md
+  app/
+    app.spec.yaml
+    business/         ← yours: prompts, tool handlers, domain logic
+    generated/        ← the compiler's: never hand-edit
+    aid.manifest.json ← provenance and per-file hashes
+```
+
+### Serving it
+
+The generator owns the routes; the application decides what to mount and how to run it. That entry point is
+yours, and it is a few lines — `app/main.py`:
+
+```python
+from fastapi import FastAPI
+
+from app.generated.routes.answer_ticket import answer_ticket_router
+
+app = FastAPI(title="my-app", version="0.1.0")
+app.include_router(answer_ticket_router)
+```
+
+Install the runtime and the server, then run it:
+
+```sh
+pip install aid-runtime-python "fastapi>=0.115,<1" "uvicorn>=0.30,<1"
+uvicorn app.main:app --reload
+```
+
+`aid gen` never writes `main.py` or a `pyproject.toml`: mounting and packaging are application decisions, and a
+generator that guessed them would overwrite your choice on the next run.
+
+The starter spec declares no pipelines, so a fresh `init` generates the structure but no routes. Add a pipeline
+to `app/app.spec.yaml` and regenerate, and one router module appears per HTTP-served pipeline.
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `aid init [dir]` | Scaffold a project: a starter spec and a README |
+| `aid validate [spec]` | Parse the spec, build the IR, run every build-time gate |
+| `aid gen [spec]` | Compile the spec and reconcile the tree with it |
+| `aid ingest [spec]` | Index a retriever corpus into the store the spec declares |
+| `aid eval [spec]` | Run the eval gate, or record the baseline it measures against |
+
+Every command accepts `--help` for its own options and `--json` for machine-readable output.
+
+## Exit codes
+
+The exit code is the contract, because it is what CI reads:
+
+| Code | Meaning |
+| --- | --- |
+| `0` | The project is as asked |
+| `1` | The spec, a gate, the target, or the working tree said no |
+| `2` | The invocation was wrong, or the CLI failed internally |
+
+`1` and `2` are deliberately distinct. A red build caused by a spec problem is fixed in the spec; a red build
+caused by `2` is fixed in the invocation or is a bug. Collapsing them sends people to the wrong file.
+
+## `--json`
+
+Every command answers `--json` with **exactly one** JSON document on stdout. Human-readable text and progress go
+to stderr, so `aid validate --json | jq` works without filtering.
+
+```sh
+npx aid validate --json | jq -r '.diagnostics[] | select(.severity=="error") | .code'
+```
+
+## The spec path
+
+Given no argument, a command reads `app/app.spec.yaml` — the path `aid init` creates and the path the generators
+compile into. Pass a path to override it:
+
+```sh
+npx aid validate path/to/other.spec.yaml
+```
+
+## Targets
+
+A spec declares the targets it is for, and `aid gen` emits one target at a time:
+
+```yaml
+project:
+  name: my-app
+  targets:
+    - py-fastapi
+    - ts-vercel
+```
+
+```sh
+npx aid gen                        # the first declared target
+npx aid gen --target ts-vercel     # any other declared target
+```
+
+`--target` selects among the targets the spec declares; it cannot invent one. Naming a target the spec does not
+declare fails with `target-unsupported` and lists what is declared. That is stricter on purpose — a spec is the
+statement of intent, and silently generating a stack it did not ask for would make the spec a lie.
+
+| Target | Emits | Runtime |
+| --- | --- | --- |
+| `py-fastapi` | FastAPI service, Pydantic models | [`aid-runtime-python`](https://pypi.org/project/aid-runtime-python/) |
+| `ts-vercel` | Next.js / Vercel functions, zod models | [`@aid-framework/runtime`](https://www.npmjs.com/package/@aid-framework/runtime) |
+
+## `aid gen`: planning, then reconciling
+
+`gen` never writes blindly. It plans the full file set from the IR, compares that plan against the tree, and only
+then reconciles.
+
+| Tier | Owner | On regeneration |
+| --- | --- | --- |
+| `app/generated/` | the compiler | overwritten — never hand-edit |
+| `app/business/` | you | created once if missing, then never touched |
+
+Preview without writing anything:
+
+```sh
+npx aid gen --dry-run
+```
+
+```text
+py-fastapi: dry run, 16 created, 0 updated, 0 unchanged, 0 kept
+created:
+  app/business/prompts/__init__.py
+  app/generated/deps.py
+  app/generated/requests.py
+  app/generated/schemas.py
+  ...
+```
+
+The counts are `created` / `updated` / `unchanged` / `kept`, so a no-op regeneration says so instead of looking
+like progress.
+
+### When a generated file has been edited by hand
+
+`gen` records a SHA-256 for every file it writes in `aid.manifest.json`. If a `generated/` file on disk no
+longer matches its recorded hash, a human edited it, and `gen` **refuses to overwrite** it. It writes the new
+content beside it as `<path>.aid-rej` and reports the conflict with both hashes.
+
+The choice is yours to make explicitly:
+
+```sh
+npx aid gen --force     # discard the hand edit and overwrite
+```
+
+or move the file into `business/` and point the business seam at it. Either way the edit is not lost silently,
+which is the failure mode that matters: a generator that overwrites unconditionally destroys the only signal it
+has that a human disagreed with it.
+
+## `aid eval`: gating behaviour, not bytes
+
+A generated service varies between runs — the model is not deterministic, and pretending otherwise produces tests
+that are either always red or measuring nothing. `aid eval` therefore samples and compares distributions:
+
+```sh
+npx aid eval --record     # record a baseline from the current behaviour
+npx aid eval              # gate the current behaviour against it
+```
+
+## What the CLI is not
+
+It is not a runtime. It reads the spec, compiles it, and reports; the generated app imports the runtime package
+for its target and runs without the CLI installed. `@aid-framework/cli` is a `devDependency` for exactly that
+reason.
+
+## API
+
+The CLI is also importable, so a build tool can drive it without a subprocess:
+
+```ts
+import { main, runCli } from '@aid-framework/cli';
+
+process.exitCode = await runCli(process.argv.slice(2));
+```
+
+| Export | Purpose |
+| --- | --- |
+| `runCli(argv)` | Run a command and return its exit code |
+| `main` | The command dispatcher |
+| `EXIT_OK`, `EXIT_REJECTED`, `EXIT_USAGE` | The exit-code constants (`0`, `1`, `2`) |
+
+## Related packages
+
+- [`@aid-framework/spec`](https://www.npmjs.com/package/@aid-framework/spec) — the spec language
+- [`@aid-framework/ir`](https://www.npmjs.com/package/@aid-framework/ir) — the IR and its build-time gates
+- [`@aid-framework/generator-py-fastapi`](https://www.npmjs.com/package/@aid-framework/generator-py-fastapi)
+- [`@aid-framework/generator-ts-vercel`](https://www.npmjs.com/package/@aid-framework/generator-ts-vercel)
+
+## License
+
+[Apache-2.0](https://github.com/aid-framework/aid-framework/blob/main/LICENSE). Code generated by AID Framework is
+not subject to this license.