העמוד הזה עוד לא תורגם; מוצגת הגרסה באנגלית.

/init & AGENTS.md

AGENTS.md is a plain Markdown file that tells agents how your project works: the stack, how to build and test, where things live. Ingot sends it with every request, so it's the first file to write in a new project.

/init

Type /init in the agent composer. Ingot looks at the repository and writes AGENTS.md at the project root, then opens it for you to review.

It reads package.json (name, description, scripts, dependencies, workspaces), the lockfile (to pick npm, pnpm, yarn or bun), the top-level folders and your .ingot/rules. No model call is needed, so it's instant and free.

# AGENTS.md — shop

A small online shop.

## Stack

- TypeScript
- React
- Vitest

## Scripts

Package manager: npm. Run these from the repository root:

- `npm run dev` — vite
- `npm run build` — tsc
- `npm test` — vitest run
- `npm run lint` — eslint .

## Layout

- `src/` — source code
- `e2e/` — end-to-end tests
- Workspaces: `packages/*`

## Working here

- Before finishing a change, run `npm run lint`, `npm test`.
- Keep changes small and focused; match the style of the code around them.
- Also follow the project rules: `.ingot/rules/style.md`.

The result is a starting point: add what only your team knows, such as conventions, gotchas and things to never touch.

/init never overwrites. If AGENTS.md already exists, Ingot leaves it as is and opens it for editing.

Nested AGENTS.md

In a monorepo, put an AGENTS.md in any folder to add instructions for the code under it:

AGENTS.md                      # whole repo: always applied
packages/AGENTS.md             # packages/ in general
packages/web/AGENTS.md         # the web app
packages/web/src/App.tsx
packages/api/AGENTS.md         # the API

Closest wins

For each file in context (files you @-mention, the open file, and files the agent read or edited), Ingot applies the root AGENTS.md plus the closest AGENTS.md above that file. Working on packages/web/src/App.tsx applies:

FileApplied
AGENTS.mdyes (the root always applies)
packages/web/AGENTS.mdyes (closest to the file)
packages/AGENTS.mdno (a closer one exists)
packages/api/AGENTS.mdno (not above the file)

A nested AGENTS.md whose folder has no file in context is not sent at all, so large monorepos stay cheap. When the root and a nested file disagree, the nested one wins for files under its folder.

Global AGENTS.md

~/.ingot/AGENTS.md applies to every project on your machine. Use it for personal preferences, such as the language you want replies in.

Keep AGENTS.md about the project as a whole. For instructions that only apply to some files or tasks, use Rules with globs or a description.