ml-intern
AGENTS.md11k starsChanged 49 days agoApache-2.0Archived repositoryView on GitHub
- Reads credentials
- Commits and pushes
We split this AGENTS.md into the rules it gives an agent
11 rules. About 0 are common, 2 are distinctive, and 9 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
9
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Very specific: line 15
If 127.0.0.1:7860 is already owned by another local process, binding the backend to ::1 lets the Vite proxy resolve localhost cleanly.
- Very specific: line 16
Prefer npm ci over npm install for setup, since npm install may rewrite frontend/package-lock.json metadata depending on npm version.
- Very specific: line 18
When asked to start the local server, export the GitHub CLI token first with export GITHUB_TOKEN="$(gh auth token)".
- Very specific: line 19
When debugging a web app issue tied to a session ID, inspect the session data in smolagents/ml-intern-sessions for additional context.
- Very specific: line 23
Before every commit, run uv run ruff check .
- Very specific: line 24
If formatting fails, run uv run ruff format ., then re-run the Ruff checks before committing.
- Distinctive: line 28
Before creating any new branch or worktree, switch to main and pull the latest changes.
- Very specific: line 32
Always use the gh CLI for GitHub operations such as opening, editing, inspecting, or commenting on PRs and issues.
- Very specific: line 34
If gh reports an invalid token or auth failure, retry the command with GH_TOKEN and GITHUB_TOKEN unset, for example env -u GH_TOKEN -u …
- Distinctive: line 40
After implementing a plan, run the required checks, commit the changes, open a GitHub PR, then start the backend and frontend local dev …
- Very specific: line 46
Keep the Space-only README frontmatter on space-main.
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Agent Notes
Local Dev Servers
- Frontend: from
frontend/, runnpm ciif dependencies are missing, thennpm run dev. - Backend (full/rollback): from
backend/, runuv run uvicorn main:app --host ::1 --port 7860. - Hosted Space:
backend/start.shrunsretired_main:app, which serves only the retirement page andGET /api. - Frontend URL: http://localhost:5173/
- Backend health check:
curl -g http://[::1]:7860/api - Frontend proxy health check:
curl http://localhost:5173/api
Notes:
- Vite proxies
/apiand/authtohttp://localhost:7860. - If
127.0.0.1:7860is already owned by another local process, binding the backend to::1lets the Vite proxy resolvelocalhostcleanly. - Prefer
npm ciovernpm installfor setup, sincenpm installmay rewritefrontend/package-lock.jsonmetadata depending on npm version. - Non-local LLM calls use
https://router.huggingface.co/v1with the active Hugging Face user's token. Web sessions and the CLI default to GLM 5.2. For local development, setHF_TOKENand optionallyML_INTERN_DEFAULT_MODEL_ID. - When asked to start the local server, export the GitHub CLI token first with
export GITHUB_TOKEN="$(gh auth token)". - When debugging a web app issue tied to a session ID, inspect the session data in
smolagents/ml-intern-sessionsfor additional context.
Development Checks
- Before every commit, run
uv run ruff check .anduv run ruff format --check .. - If formatting fails, run
uv run ruff format ., then re-run the Ruff checks before committing.
Git Workflow
- Before creating any new branch or worktree, switch to
mainand pull the latest changes.
GitHub CLI
- Always use the
ghCLI for GitHub operations such as opening, editing, inspecting, or commenting on PRs and issues. - For multiline PR descriptions, prefer
gh pr edit <number> --body-file <file>over inline--bodyso shell quoting,$env-var names, backticks, and newlines are preserved correctly. - If
ghreports an invalid token or auth failure, retry the command withGH_TOKENandGITHUB_TOKENunset, for exampleenv -u GH_TOKEN -u GITHUB_TOKEN gh pr create ..., soghcan use the stored login token instead of a stale environment token. - In Codex, sandboxed
ghauth checks can report a valid keyring login as invalid when GitHub network access is restricted. Before telling the user to re-authenticate, retry with both env tokens unset and GitHub network access enabled.
GitHub PRs
- Open code changes as GitHub PRs first. Do not push code changes directly to the Hugging Face Space deployment branch or Space remote before the PR has been opened, reviewed, and merged, unless the user explicitly asks to bypass the PR flow.
- After implementing a plan, run the required checks, commit the changes, open a GitHub PR, then start the backend and frontend local dev servers for testing.
Hugging Face Space Deploys
- The Space remote is
spaceand points tohttps://huggingface.co/spaces/smolagents/ml-intern. - Deploy GitHub
mainto the Space from the localspace-mainbranch by mergingorigin/mainintospace-mainwith a single merge commit, then pushingspace-main:mainto thespaceremote. - Keep the Space-only README frontmatter on
space-main;.gitattributesshould containREADME.md merge=oursand the local repo config should includemerge.ours.driver=true. - Local dev commonly uses a personal
HF_TOKEN, but the deployed Space uses HF OAuth tokens. When adding Hub features, make sure the Space READMEhf_oauth_scopesfrontmatter and the backend OAuth request inbackend/routes/auth.pyinclude the scopes required by the Hub APIs being called. A feature can work locally with a broad PAT and still fail in production with 403s if OAuth scopes are missing; after changing scopes, users may need to log out and log in again to receive a fresh token. - Recommended deploy flow:
git pull --ff-only origin main
git switch space-main
git config merge.ours.driver true
git merge --no-ff origin/main -m "Deploy $(date +%Y-%m-%d)" \
-m "Co-authored-by: OpenAI Codex <codex@openai.com>"
git push space space-main:main
git switch mainWhere files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

