60 lines
1.3 KiB
Markdown
60 lines
1.3 KiB
Markdown
|
# amduat-app-next (Scaffold)
|
||
|
|
|
||
|
|
Starter project scaffold for building an app against `amduatd` v2.
|
||
|
|
|
||
|
|
## Included handoff assets
|
||
|
|
|
||
|
|
- `docs/v2-app-developer-guide.md` (compact app guide)
|
||
|
|
- `contracts/amduatd-api-contract.v2.json` (machine contract)
|
||
|
|
- `scripts/graph_client_helpers.sh` (reusable shell helpers)
|
||
|
|
|
||
|
|
## Quick start
|
||
|
|
|
||
|
|
1. Configure environment:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
cp config/env.example config/env.local
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Run startup checks against a running `amduatd` socket:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
./scripts/bootstrap_check.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Run sample idempotent batch ingest:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
./scripts/ingest_example.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Run sample changes sync loop:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
./scripts/sync_loop.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
## v2 Vertical Slice CLI
|
||
|
|
|
||
|
|
Use the integrated v2 app flow wrapper:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
./scripts/v2_app.sh startup-check
|
||
|
|
./scripts/v2_app.sh ingest '{"idempotency_key":"k1","mode":"continue_on_error","nodes":[{"name":"doc:1"}]}'
|
||
|
|
./scripts/v2_app.sh sync-once
|
||
|
|
./scripts/v2_app.sh retrieve 'doc:1' 'ms.within_domain'
|
||
|
|
./scripts/v2_app.sh tombstone '<edge_ref>'
|
||
|
|
```
|
||
|
|
|
||
|
|
Run integration coverage (requires running `amduatd` + `jq`):
|
||
|
|
|
||
|
|
```sh
|
||
|
|
./tests/integration_v2.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
- This scaffold assumes local Unix-socket access to `amduatd`.
|
||
|
|
- Graph cursors are opaque and must be persisted exactly as returned.
|
||
|
|
- Keep `contracts/amduatd-api-contract.v2.json` in sync with upstream when you pull updates.
|