From 0778a97000e5e80847a904a145fdf8f8a41c5d70 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Wed, 15 Jul 2026 22:51:27 +0000 Subject: [PATCH] Add AGENTS.md with Cursor Cloud dev environment instructions Co-authored-by: Ibrahim Awwal --- AGENTS.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..40d2c61d --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,16 @@ +# AGENTS.md + +## Cursor Cloud specific instructions + +This repo has two independent components; neither is a networked/backend service and there is no database, queue, or Docker. + +### `skills-ref/` — Python reference CLI/library +- Managed with `uv` (Python `>=3.11`). Standard commands are documented in `skills-ref/CLAUDE.md` (e.g. `uv run pytest`, `uv run ruff check .`, `uv run ruff format .`). Run them from inside `skills-ref/`. +- `uv` installs to `~/.local/bin` (already on PATH via `~/.bashrc`). If a non-login shell can't find `uv`, prefix commands with `PATH="$HOME/.local/bin:$PATH"`. +- The CLI entry point is `skills-ref` (subcommands `validate`, `read-properties`, `to-prompt`); run via `uv run skills-ref `. +- Gotcha: `validate` requires the skill's directory name to exactly match the `name` field in `SKILL.md` frontmatter, otherwise it fails validation. + +### `docs/` — Mintlify documentation site +- Run with `npm run dev` from the repo root (wraps `cd docs && npx mint dev`) or `mint dev` from `docs/`. Serves at `http://localhost:3000` and redirects `/` → `/home`. +- The `mint` CLI is installed globally into a user-writable prefix (`~/.npm-global`, on PATH via `~/.bashrc`) because the default global prefix is not writable. +- Harmless noise: shells print an nvm/npm-prefix warning ("`.npmrc` file ... incompatible with nvm") because of the custom npm prefix. It does not affect `mint` or `npm run dev`.