Skip to content

Commit 66de9ca

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

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# AGENTS.md
2+
3+
A Motoko client library for the OpenAI REST API, distributed as the `openai-client` package via [mops](https://mops.one).
4+
5+
## Generated code
6+
7+
This package is produced by [OpenAPI Generator](https://openapi-generator.tech) (`MotokoClientCodegen`); see `README.md` for API/generator versions. Treat the package contents as build output:
8+
9+
- Do NOT hand-edit `src/`, `README.md`, or `mops.toml` — regeneration overwrites them. The set of generator-managed files is listed in `.openapi-generator/FILES`.
10+
- `.openapi-generator-ignore` controls which files the generator is allowed to overwrite; edit it (not the generated files) to protect a file.
11+
- The generator version is pinned in `.openapi-generator/VERSION`.
12+
13+
## Build / test
14+
15+
There is no build script, test suite, lint, or format config in this repo, and no CI workflows under `.github/`. Consumers build it as a Motoko dependency, not in-tree.
16+
17+
- Toolchain is pinned in `mops.toml`: `moc = "1.4.1"`. Use this exact Motoko compiler version when type-checking.
18+
- Dependencies and their versions are declared in `[dependencies]` of `mops.toml` and locked in `mops.lock`. With mops installed, `mops install` fetches them; `.mops/` (git-ignored) holds the resolved sources.
19+
20+
## Layout
21+
22+
- `src/Apis/` — one module per API group (e.g. `ChatApi.mo`).
23+
- `src/Models/` — request/response types.
24+
- `src/Config.mo``defaultConfig` and client configuration.
25+
26+
## Conventions
27+
28+
- This package ships a curated subset of the OpenAI surface (see "API Subset" in `README.md`); `README.md`'s "APIs"/"Models" lists describe the full upstream schema, not what is shipped in `src/`. Trust `src/` for what actually exists.
29+
- Public package name for imports is `openai-client` (e.g. `import ChatApi "mo:openai-client/Apis/ChatApi"`).

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)