opencode-gpt-imagegen: Instructions file for Codex

AGENTS.md

Contribution Policy

If you are helping someone other than the maintainer (@yuji-hatakeyama) contribute, read CONTRIBUTING.md before you write code, and follow it.

When you open a pull request, including one for the maintainer, write its description by filling in .github/pull_request_template.md. Write its title as described in CONTRIBUTING.md.

Project Shape

• Bun is the package manager/runtime; use bun install --frozen-lockfile with the committed bun.lock.
• The plugin entry is src/index.ts, which exposes V1 server and V2 setup. Adapters in src/v1.ts and src/v2.ts translate host registration, credentials, session directories, and results. src/imagegen.ts owns the shared schema, description, validation, and generation flow. Image helpers retain their role-based modules.
• Both SDKs are development-only type dependencies. Zod is a direct runtime dependency. V2 converts the shared schema to JSON Schema with the plugin's own Zod instance so descriptions survive a different host Zod registry.
• bun run build bundles src into a single self-contained dist/index.js via bun build --target node --format esm --packages external (runtime dependencies stay external). Bundling avoids the extensionless relative imports tsc would emit, which native Node ESM cannot resolve. No .d.ts is published — the plugin is loaded by OpenCode at runtime, not imported as a typed library.
• dist/ is ignored locally but is the publish artifact (just index.js). Run bun run build before inspecting package output.
• bunfig.toml enforces install.minimumReleaseAge = 604800 (1 week): newly published versions are filtered out by bun install / bun add / bun outdated.

Commands

• Tests are split by kind: tests/unit/ (unit tests of the src/ modules, including the plugin entry) and tests/e2e/ (gpt_imagegen.test.ts).
• bun run typecheck runs tsc --noEmit over src and tests.
• bunx biome ci . is the CI formatter/linter check.
• bun run check runs biome check --write .; it may modify files.
• bun run test runs bun test tests/unit — unit tests only, and is what CI uses. (A bare bun test would also discover the e2e files under tests/e2e/ and try to run them for real, so prefer the script.)
• bun run test:e2e sets OPENCODE_MODEL=openai/gpt-6-sol and runs tests/e2e/gpt_imagegen.test.ts in its own bun test process, which keeps the unit tests' process.env edits out of the e2e opencode spawn. It can take minutes because it calls opencode run and generates real images.
• CI runs bun run typecheck, bunx biome ci ., and bun run test. It does not run bun run test:e2e, which needs real auth and generations.