AGENTS.md examples from real projects

ofkmAGENTS.md

arcane

ofkm/arcane/AGENTS.md

Arcane agent guide Arcane is a Docker management platform. - **Backend:** Go - **Frontend:** SvelteKit - **Also:** headless agent modes and a Cobra CLI ## Ground rules (every change) - Follow [AI_POLICY.md](./AI_POLICY.md), including

OpenCoworkAIPipes a download into a shellAGENTS.md

open-codesign

OpenCoworkAI/open-codesign/AGENTS.md

package.json`, workspace manifests, and `pnpm-lock.yaml`. Read those files instead of trusting stale docs. ### Frontend - React + Vite + Tailwind v4 + CSS variables. - State uses Zustand. Do not introduce Redux, Recoil, or MobX

OrchardCMSAGENTS.md

OrchardCore

OrchardCMS/OrchardCore/AGENTS.md

Version 24.x LTS (for asset compilation) - **Yarn**: Version 4.x (package manager for frontend assets) ## Building the Project ### Command Line ```bash # Navigate to the web project cd src/OrchardCore.Cms.Web

Graylog2AGENTS.md

graylog2-server

Graylog2/graylog2-server/AGENTS.md

AGENTS.md ## Frontend The web interface lives in `graylog2-web-interface/` and has its own conventions. Before modifying frontend code, you must read `graylog2-web-interface/AGENTS.md` and follow its conventions

podman-desktopAGENTS.md

podman-desktop

podman-desktop/podman-desktop/AGENTS.md

APIs | ### Key Packages ``` packages/main/ - Electron main process (Inversify DI, IPC handlers) packages/renderer/ - Svelte UI (frontend) packages/ui/ - Shared UI components (@podman-desktop/ui-svelte) packages/api/ - Shared types between renderer, main, and preloads

No other project uses it yet

LibrePhotosReads credentialsAGENTS.md

librephotos

LibrePhotos/librephotos/AGENTS.md

eslint-disable` or a baseline entry to get green is not a fix. The frontend has no baseline (its `tsc` reports zero errors); the backend mypy baseline only shrinks

leejetAGENTS.md

stable-diffusion.cpp

leejet/stable-diffusion.cpp/AGENTS.md

read and follow [the built-in recipe policy](examples/server/recipes/README.md). * `examples/server/frontend/` - git submodule containing independent frontend code. Avoid modifying it unless explicitly requested. ### Documentation and Tooling * `docs/` - documentation for supported models

elsa-workflowsAGENTS.md

elsa-core

elsa-workflows/elsa-core/AGENTS.md

extensions/test/`, `extensions/docs/`, `extensions/samples/`: Extensions-owned code, tests, documentation and samples. - `studio/react/`: React Studio Preview frontend and host; read its contributor guidance. - `studio/src/`, `studio/test/`, `studio/docs/`, `studio/samples/`: Studio-owned code, tests, documentation

No other project uses it yet

sysadminsmediaAGENTS.md

homebox

sysadminsmedia/homebox/.github/AGENTS.md

This is a Go based repository with a VueJS client for the frontend built with Vite and Nuxt, with ShadCN. To make life easier, the use of a Taskfile

No other project uses it yet

Azure-SamplesAGENTS.md

azure-search-openai-demo

Azure-Samples/azure-search-openai-demo/AGENTS.md

state of the project. ## Overall code layout * app: Contains the main application code, including frontend and backend. * app/backend: Contains the Python backend code, written with Quart framework. * app/backend/approaches: Contains

midwayjsAGENTS.md

midway / openspec

midwayjs/midway/openspec/AGENTS.md

tasks.md:** ```markdown ## 1. Implementation - [ ] 1.1 Create database schema - [ ] 1.2 Implement API endpoint - [ ] 1.3 Add frontend component - [ ] 1.4 Write tests ``` 5. **Create design.md when needed:** Create `design.md

samuelclayAGENTS.md

NewsBlur

samuelclay/NewsBlur/AGENTS.md

docker restart newsblur_celery` (or `newsblur_celery_ ` in worktrees) - Provider implementations are in `apps/ask_ai/providers.py` - **Frontend model selectors**: Search for `data-model="gemini` to find all dropdown locations - **CSS for model

xerrorsReads credentialsAGENTS.md

Yuxi

xerrors/Yuxi/AGENTS.md

Yuxi 是基于 LangGraph、FastAPI、Vue 和多种持久化服务构建的知识库与多智能体平台。Docker Compose 是开发拓扑的事实来源；用符号搜索确认模块的真实实现。 ## 按任务范围加载 - 始终以本文件为准；修改 `backend/`、`frontend/` 或 `docs/` 时，同时读取该子树的 `AGENTS.md`。子树规则只补充本目录，不复制回根文件。 - 改一个文案、修一个小 bug、机械重命名或等价清理：只读根与适用子树指令及直接相关源码或文档；架构和开发指南按下一条的任务条件加载。 - 跨模块设计或实现、改变状态

xerrorsAGENTS.md

Yuxi / frontend

xerrors/Yuxi/frontend/AGENTS.md

Frontend 约定 本目录是 Vue 3 / Vite 前端。先阅读根 [AGENTS.md](../AGENTS.md)；架构与开发指南按根文件的任务范围加载。涉及界面设计、交互或响应式方案时读取[设计规范](../docs/develop-guides/design.md)。 - API 调用统一放在 `src/apis`；组件不直接拼接普通 HTTP 请求。 - 跨模块导入只使用 `@/modules/ `（模型/用例）或 `@/modules/ /ui/**.vue`（组件

superdesigndevAGENTS.md

treg

superdesigndev/treg/AGENTS.md

modules" import-linter contract lists them and fails the build. - **The dashboard** lives in `frontend/` (Vue components, TypeScript entry/transport, Vite). Build with `bash scripts/build-dashboard.sh`; generated assets in `src/treg/web/dashboard/` ship with

BuilderIOReads credentialsAGENTS.md

agent-native

BuilderIO/agent-native/AGENTS.md

operations in `actions/` with `defineAction`; the agent calls them as tools and the frontend calls the shared action surface through `useActionQuery` / `useActionMutation`. - Client code imports named helpers, hooks, or client

No other project uses it yet

4grayAGENTS.md

iptvnator

4gray/iptvnator/AGENTS.md

targets before choosing checks. Prefer the smallest relevant Nx target. - Development: `pnpm run serve:frontend` or `pnpm run serve:backend`. - Tests: `pnpm nx test `; lint: `pnpm nx lint `. - Find checks

evcc-ioAGENTS.md

evcc

evcc-io/evcc/AGENTS.md

Charge Controller and home energy management system written in Go with a Vue.js frontend - The system manages electric vehicle charging, integrates with solar systems, and provides local energy management without

ValueCell-aiAGENTS.md

ClawX

ValueCell-ai/ClawX/AGENTS.md

performance profiles | `pnpm run perf:chat` | | Electron Main inspector | `pnpm run profile:main` | | Build frontend only | `pnpm run build:vite` | ### Non-obvious caveats - **Node.js floor**: OpenClaw 2026.10.10 hard-requires Node

kubernetes-sigsAGENTS.md

headlamp

kubernetes-sigs/headlamp/AGENTS.md

agent must populate before committing):** > - `/backend/pkg/k8cache/cacheInvalidation.go` > - `/backend/pkg/kubeconfig/contextStore.go` > > **README.md files:** > - `/README.md` - Main project README > - `/frontend/README.md` - Frontend-specific README > - `/backend/README.md` - Backend quickstart guide > - `/app/README.md` - Desktop app README > - `/e2e-tests/README.md` - End-to-end testing

No other project uses it yet