Skip to content

Add AGENTS.md with Cursor Cloud dev environment instructions #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ibrahima wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add AGENTS.md with Cursor Cloud dev environment instructions #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <cmd> <skill_path>`.
- 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`.