Skip to content

Commit beed45b

Browse files
author
caffeine-ci-generic-rw[bot]
committed
docs: seed AGENTS.md
1 parent 3209b12 commit beed45b

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AGENTS.md
2+
3+
A Motoko client library for the OpenAI REST API, distributed as a [mops](https://mops.one) package.
4+
5+
## Generated code — do not hand-edit
6+
7+
The entire `src/` tree is produced by the [OpenAPI Generator](https://openapi-generator.tech) (`MotokoClientCodegen`); the exact list of generated paths is in `.openapi-generator/FILES`. Do not hand-edit generated files — changes are lost on regeneration. Files listed in `.openapi-generator-ignore` are preserved across regeneration. `README.md` and `CHANGELOG.md` are also generator-managed.
8+
9+
This package ships a curated subset of the upstream OpenAPI surface (Chat, Completions, Models, Embeddings, Images, Audio, Moderations, Files) plus the models they transitively reference; other APIs are pruned.
10+
11+
## Layout
12+
13+
- `src/Config.mo` — shared `Config` type and `defaultConfig` (base URL, cycles, auth).
14+
- `src/Apis/` — one module per API group (e.g. `ChatApi.mo`).
15+
- `src/Models/` — request/response type modules, one per type.
16+
17+
## Toolchain
18+
19+
- Motoko compiler is pinned in `mops.toml`: `moc = "1.4.1"`. Use that version.
20+
- Dependencies are declared in `mops.toml` and locked in `mops.lock`; install them with `mops install`.
21+
- The `files` field in `mops.toml` defines what the published package contains (`src/Config.mo`, `src/Apis/**/*.mo`, `src/Models/**/*.mo`).
22+
23+
## Notes
24+
25+
- `.mops/` is a local install directory and is gitignored.
26+
- There are no CI workflows, tests, lint, or format scripts in this repository; do not assume any exist.
27+
- The client makes HTTP outcalls via the IC management canister, which require cycles at runtime; this is a deployment concern, not a build step.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
See @AGENTS.md

0 commit comments

Comments
 (0)