feat: support simple projects and root Git repositories
Allow registering a single Git repository at the engineering project root with --path . while retaining path safety checks. Document Git-optional projects first and cover plain folders, root repositories, and multiple repositories in process tests and native smoke scenarios. Validated with 23 passing tests and macOS ARM64 native smoke checks for all three layouts.
This commit is contained in:
@@ -1,7 +1,8 @@
|
||||
# ai-engineering
|
||||
|
||||
An open, agent-agnostic engineering protocol and CLI. Works belong to an engineering
|
||||
project spanning independent repositories. Canonical files preserve goals, discussion,
|
||||
An open, agent-agnostic engineering protocol and CLI for simple projects and projects
|
||||
spanning multiple repositories. Git is optional. Works belong to the engineering
|
||||
project. Canonical files preserve goals, discussion,
|
||||
draft decisions and evidence so another person or agent can continue without chat history.
|
||||
|
||||
Milestones 0 and 1 are implemented. The application runs locally in non-web mode;
|
||||
@@ -65,7 +66,38 @@ macOS x86_64 remains a target with an upstream toolchain availability limitation
|
||||
GraalVM 25 dropped that port; see [roadmap](docs/roadmap.md). Local verification
|
||||
results, including which native binaries were actually tested, are in [experiments](docs/experiments.md).
|
||||
|
||||
## Two-repository example
|
||||
## Start in a simple project
|
||||
|
||||
Run inside the folder you already use for your application, game or library:
|
||||
|
||||
```sh
|
||||
ai-engineering init --name "My Application"
|
||||
ai-engineering work create "Improve the application" \
|
||||
--goal "Preserve enough context to continue in another session"
|
||||
ai-engineering discussion add WRK-0001 --text "Record the current state and next questions."
|
||||
ai-engineering decision draft WRK-0001 --title "Evaluate the proposed approach"
|
||||
ai-engineering work context WRK-0001 --format markdown
|
||||
ai-engineering project validate
|
||||
```
|
||||
|
||||
This creates `.ai-engineering/` beside your existing source files. A project with
|
||||
`repositories: []` is fully supported; the workflow above does not require Git to be
|
||||
installed. Its Works have no Git revision snapshots. Git becomes relevant when you
|
||||
choose to register repositories.
|
||||
|
||||
If the project folder is itself an existing Git repository, you can register it:
|
||||
|
||||
```sh
|
||||
ai-engineering repo add app --path .
|
||||
ai-engineering work create "Investigate a change" --repo app
|
||||
```
|
||||
|
||||
Registration is optional and defaults to read-only. For example, a standalone
|
||||
`zelda-1/` project can keep `.ai-engineering/` directly inside `zelda-1/`, without
|
||||
registering the separate runtime or editor repositories. Each Work explicitly selects
|
||||
any registered repositories it needs with `--repo`.
|
||||
|
||||
## Multiple repositories in one project
|
||||
|
||||
From an external project directory with existing `runtime/` and `studio/` Git
|
||||
repositories, run:
|
||||
|
||||
Reference in New Issue
Block a user