init

# Init You're here because a coding project needs an agent bootstrap and someone wants you to do it. One deliverable: **`AGENTS.md` at the repo root** — the open agents.md standard (https://agents.md). One file, consumed by every major AI coding agent. Highest leverage. ## When to use - The system prompt contains `<bootstrap_check>`. - The user runs `/init` from the UI palette. - The user explicitly asks to bootstrap, init, or generate AGENTS.md for a project. If the workspace is not a meaningful git repo or has no real code, **do not bootstrap**. Explain why. ## Bootstrap procedure ### 1. Identify the workspace shape Single repo, monorepo, or parent dir with multiple repos. (See "Multi-repo exception" below if it's the third.) ### 2. Inspect the codebase — evidence over guesses Detect the ecosystem by manifest file (first match wins). First-class support: | Ecosystem | Manifest | Install / Test / Build commands | |---|---|---| | Node.js | `package.json` | Read `scripts.{dev,build,test,lint,typecheck}`; package manager from `packageManager` field or `pnpm-lock.yaml` / `yarn.lock` / `package-lock.json` | | Python | `pyproject.toml` | Read `[tool.poetry.scripts]` / `[project.scripts]`; or fall back to `pytest`, `ruff`, `mypy` if those configs exist | | Rust | `Cargo.toml` | `cargo build`, `cargo test`, `cargo clippy`, `cargo fmt` | | Go | `go.mod` | `go build ./...`, `go test ./...`, `go vet ./...` | For any other ecosystem (Java/Maven, Ruby/Bundler, PHP/Composer, …) write the AGENTS.md sections with placeholders and tell the user to fill them in. Also inspect: - Top-level directories and their purpose - CI/CD configuration (`.github/workflows/`, `.gitlab-ci.yml`, `.circleci/`) for the canonical test invocation - `.eslintrc*` / `.prettierrc*` / `pyproject.toml [tool.ruff]` / `rustfmt.toml` for code style - Default branch via `git symbolic-ref --short refs/remotes/origin/HEAD 2>/dev/null || git config init.defaultBranch || echo main` (works offline and across locales; the legacy `git remote show origin` form requires network reachability AND an English-locale `HEAD branch:` line) ### 3. Generate the root `AGENTS.md` Path: `<repo-root>/AGENTS.md`. **No subdirectory, no symlinks.** First-class for every AGENTS.md-aware agent. #### 3a. Pre-write check - **File does not exist** → write the full template (step 3b). - **File exists** → **ASK the user** which path to take: 1. **Skip** — leave the existing file untouched (default if the user is silent). 2. **Overwrite (with backup)** — copy current to `AGENTS.md.bak.<unix-ts>` then write the fresh template. 3. **Show diff** — print a unified diff between the existing file and the proposed template; user copies the edits they want by hand. **Pause and do not write or modify any file until the user explicitly picks 1, 2, or 3** (or any phrasing you can confidently map to one of the three). "Default if silent = skip" is a fallback only after the user has actually been asked and remains silent across the same turn — never a license to decide for them up-front. Do not invent a fourth path. Do not write a "Mavis-managed" block — the file belongs to the user. #### 3b. Template Fill the placeholders below from step 2 detection. Trim sections that don't apply (e.g. `Typecheck` only if the project has TypeScript). Keep it tight — aim for under 80 lines. ```md # AGENTS.md <one-line project description — from package.json `description`, Cargo.toml `description`, pyproject `description`, or the first sentence of README.md> ## Setup commands - Install deps: `<pnpm install | npm install | poetry install | cargo build | go mod download>` - Start dev: `<pnpm dev | npm run dev | uvicorn ... | cargo run | go run ./...>` - Build: `<pnpm build | cargo build --release | go build ./...>` - Test: `<pnpm test | pytest | cargo test | go test ./...>` - Lint: `<pnpm lint | ruff check | cargo clippy | go vet ./...>` - Typecheck: `<pnpm typecheck | mypy . | …>` # omit if not applicable ## Project layout <auto-detected top-level directories, one per line, with a short purpose> - `packages/` — workspace packages - `apps/` — deployable apps - `scripts/` — repo utility scripts - `docs/` — long-form documentation ## Code style <3-5 lines summarising the inferred conventions> - TypeScript strict mode (`tsconfig.json: strict: true`) - Prettier: single quotes, 100-char width - ESLint config: `.eslintrc.js` - Run `<lint:fix command>` before committing ## Testing instructions - Unit tests: `<test command>` (<framework, e.g. Vitest / pytest / cargo test>) - E2E tests: `<e2e command>` (<Playwright / Cypress / …>) # omit if none - Add tests for every new behavior — see existing `*.test.<ext>` files in the same package - All tests must pass before opening a PR ## PR & commit conventions - Branch from `<default-branch>`; never push to it directly - Commit message: conventional commits (`feat:` / `fix:` / `docs:` / `refactor:`) - Open PR via `<gh pr create | glab mr create>` once CI is green ## Security - Never commit secrets — `.env` is in `.gitignore` - <add any security-policy hints inferred from `SECURITY.md`, `package.json` engines, etc.> ``` ### 4. Tell the user Print: 1. Whether `AGENTS.md` was created, overwritten (with backup path), or skipped. 2. Reminder: commit `AGENTS.md` to git — the file IS the agent-facing project definition. 3. How to grow it later: keep it updated as commands/conventions change; load `create-agent` to add a standalone helper agent. ## Multi-repo exception If the workspace is a parent directory containing multiple independent git repos: - Create a root `AGENTS.md` that explains what each repo is for and how they relate. - Bootstrap each real sub-repo separately with its own local `AGENTS.md`. ## Guardrails - Base the AGENTS.md content on what the repo actually needs, not on a generic template. - Do NOT hardcode a `git commit` step into the bootstrap itself — let the user commit when they're ready. - Do NOT inject Mavis-branded sections into `AGENTS.md`. The file is for every agent; Mavis is just one of them.