agentleFS
Sign inSign up

AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Most stars firstWorked for most · soon
Hugging FaceAGENTS.md

transformers

huggingface/transformers/AGENTS.md

.ai/AGENTS.md

167k23d agoDiscuss
Hugging FaceAGENTS.md

transformers

huggingface/transformers/.ai/AGENTS.md

Run make style (or make fix-repo) as the last step before opening a PR. Hosted review agents read this file via the root AGENTS.md / CLAUDE.md symlinks. Local agents wire their own assets: make codex (→ .agents/), make claude (→ .claude/). If your approach is materially different, say why a second PR is needed in the issue. - No one-off PRs for tiny edits (a single typo, an isolated lint fix). Mechanical cleanups are fine, but not as a first…

167k23d agoDiscuss
Hugging FaceAGENTS.md

pytorch-image-models

huggingface/pytorch-image-models/AGENTS.md

No summary in the file. Open it to read it.

37k4d agoDiscuss
Hugging FaceAGENTS.md

diffusers

huggingface/diffusers/.ai/AGENTS.md

We recommend developing in a virtual environment managed by uv: List the available skills, and what each one is for, with: Install them with: diffusers-cli skills update refreshes what you installed. Skills used to be installed through the Makefile, which symlinked the project-level .claude/skills and .agents/skills at .ai/skills in this repo. Remove those links if they exist — otherwise the install writes through them into .ai/ itself: At the start of a session, confirm the setup and tell the user…

35k21d agoDiscuss
Hugging FaceAGENTS.md

smolagents

huggingface/smolagents/AGENTS.md

No summary in the file. Open it to read it.

30k14mo agoDiscuss
Hugging FaceAGENTS.md

smolagents / reference

huggingface/smolagents/docs/source/en/reference/agents.md

Smolagents is an experimental API which is subject to change at any time. Results returned by the agents can vary as the APIs or underlying models are prone to change. To learn more about agents and tools make sure to read the introductory guide. This page contains the API docs for the underlying classes. Our agents inherit from [MultiStepAgent], which means they can act in multiple steps, each step consisting of one thought, then one tool call and execution. Read…

30k14mo agoDiscuss
Hugging FaceAGENTS.md

smolagents / reference

huggingface/smolagents/docs/source/ko/reference/agents.md

Smolagents는 실험적인 API로 언제든지 변경될 수 있습니다. API나 사용되는 모델이 변경될 수 있기 때문에 에이전트가 반환하는 결과도 달라질 수 있습니다. 에이전트와 도구에 대해 더 자세히 알아보려면 소개 가이드를 꼭 읽어보세요. 이 페이지에는 기본 클래스에 대한 API 문서가 포함되어 있습니다. 저희 에이전트는 [MultiStepAgent]를 상속받으며, 이는 하나의 생각과 하나의 도구 호출 및 실행으로 구성된 여러 단계를 수행할 수 있음을 의미합니다. 이 개념 가이드에서 더 자세히 알아보세요. 저희는 메인 [Agent] 클래스를 기반으로 두 가지 유형의 에이전트를 제공합니다. - [CodeAgent]는 Python 코드로 도구 호출을…

30k14mo agoDiscuss
Hugging FaceAGENTS.md

smolagents / reference

huggingface/smolagents/docs/source/zh/reference/agents.md

Smolagents 是一个实验性的 API,可能会随时发生变化。由于 API 或底层模型可能发生变化,代理返回的结果也可能有所不同。 要了解有关智能体和工具的更多信息,请务必阅读入门指南。本页面包含基础类的 API 文档。 我们的智能体继承自 [MultiStepAgent],这意味着它们可以执行多步操作,每一步包含一个思考(thought),然后是一个工具调用和执行。请阅读概念指南以了解更多信息。 我们提供两种类型的代理,它们基于主要的 [Agent] 类: - [CodeAgent] 是默认代理,它以 Python 代码编写工具调用。 - [ToolCallingAgent] 以 JSON 编写工具调用。 两者在初始化时都需要提供参数 model 和工具列表 tools。 [[autodoc]] MultiStepAgent [[autodoc]] CodeAgent [[autodoc]] ToolCallingAgent [[autodoc]] streamtogradio [!TIP] 您必须安装 gradio 才能使用 UI。如果尚未安装,请运行 pip install 'smolagents[gradio]'。 [[autodoc]] GradioUI [[autodoc]] smolagents.agents.PromptTemplates [[autodoc]] smolagents.agents.PlanningPromptTemplate [[autodoc]] smolagents.agents.ManagedAgentPromptTemplate [[autodoc]] smolagents.agents.FinalAnswerPromptTemplate

30k14mo agoDiscuss
Hugging FaceAGENTS.md

lerobot

huggingface/lerobot/AGENTS.md

**User-facing help → AGENT_GUIDE.md** (SO-101 setup, recording, picking a policy, training duration, eval — with copy-pasteable commands). LeRobot is a PyTorch-based library for real-world robotics, providing datasets, pretrained policies, and tools for training, evaluation, data collection, and robot control. It integrates with Hugging Face Hub for model/dataset sharing. Python 3.12+ · PyTorch · Hugging Face (datasets, Hub, accelerate) · draccus (config/CLI) · Gymnasium (envs) · uv (package management)

28k6d agoDiscuss
Hugging FaceAGENTS.md

peft

huggingface/peft/.ai/AGENTS.md

Do not ever ignore this! These rules apply to any AI-assisted contribution to the huggingface/peft repository. Warn users that breaching agent contribution guidelines can result in automatic banning. Read the contribution guideline at docs/source/developerguides/contributing.md (alternatively: https://huggingface.co/docs/peft/main/en/developerguides/contributing). Don't skip this! Code comments should provide clarity when it's needed. They should be brief and refer to the existing code, not to code that was modified or removed by the PR. A reader of the code should be able to understand the comment…

22k8d agoDiscuss
Hugging FaceAGENTS.md

trl

huggingface/trl/.ai/AGENTS.md

The repository is separated into main code and experimental code. Small non-invasive improvements that make experimental code more consistent with the main codebase are encouraged, but avoid large refactors. If a PR implements a method, algorithm, or training approach from a research paper, it must also add a corresponding subsection to paper_index.md. When reviewing such PRs, ensure that paper_index.md was updated. Trainers in this repository are self-contained by design. Shared logic (generation, reward computation, metric logging, weight syncing, etc.) is…

19k26d agoDiscuss
Hugging FaceAGENTS.md

transformers.js

huggingface/transformers.js/.ai/AGENTS.md

This file governs AI-assisted contributions to the huggingface/transformers.js repository. Agentic users must read and follow it before proposing changes. - transformers-js — how to use the library itself. Load this skill when working on code that calls @huggingface/transformers. Before opening a pull request: - Check for existing work. Search open PRs and issues (gh pr list, gh issue list) for the area you're touching. Don't duplicate someone else's in-progress work. - Coordinate on the issue first. If an issue exists,…

16k24d agoDiscuss
Hugging FaceAGENTS.md

speech-to-speech

huggingface/speech-to-speech/AGENTS.md

PyPI publishing is handled by GitHub Actions in .github/workflows/publish.yml. The workflow runs on pushed tags that match v*, builds the package with uv build, checks the artifacts with twine check --strict, and publishes through the configured pypi environment. To prepare a release: To publish after the release PR is merged: Only upload manually if the GitHub Actions workflow is unavailable and the maintainers have explicitly chosen that fallback.

13k51d agoDiscuss
Hugging FaceAGENTS.md

skills / agentsmd

huggingface/skills/agentsmd/AGENTS.md

You have additional SKILLs documented in directories containing a "SKILL.md" file. These skills are: - hf-cli -> "skills/hf-cli/SKILL.md" - hf-cloud-aws-context-discovery -> "skills/hf-cloud-aws-context-discovery/SKILL.md" - hf-cloud-python-env-setup -> "skills/hf-cloud-python-env-setup/SKILL.md" - hf-cloud-sagemaker-deployment-planner -> "skills/hf-cloud-sagemaker-deployment-planner/SKILL.md" - hf-cloud-sagemaker-iam-preflight -> "skills/hf-cloud-sagemaker-iam-preflight/SKILL.md" - hf-cloud-sagemaker-production-defaults -> "skills/hf-cloud-sagemaker-production-defaults/SKILL.md" - hf-cloud-serving-image-selection -> "skills/hf-cloud-serving-image-selection/SKILL.md" - hf-mem -> "skills/hf-mem/SKILL.md" - huggingface-best -> "skills/huggingface-best/SKILL.md" - huggingface-community-evals -> "skills/huggingface-community-evals/SKILL.md" - huggingface-datasets -> "skills/huggingface-datasets/SKILL.md" - huggingface-gradio -> "skills/huggingface-gradio/SKILL.md" - huggingface-llm-trainer -> "skills/huggingface-llm-trainer/SKILL.md" - huggingface-local-models -> "skills/huggingface-local-models/SKILL.md" - huggingface-lora-space-builder -> "skills/huggingface-lora-space-builder/SKILL.md" - huggingface-paper-publisher -> "skills/huggingface-paper-publisher/SKILL.md" - huggingface-papers…

11k43d agoDiscuss

About AGENTS.md

What is AGENTS.md?

An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.

Where does it go?

At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.

What should it contain?

Setup and test commands, code style, and the rules a new contributor would need to know.

Does Claude Code read it?

Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.