Skip to content

Commit 876758c

Browse files
cursoragentfathiraz
andcommitted
Add AGENTS.md with Cursor Cloud development instructions
Co-authored-by: fathiraz arthuro <arthurofathiraz@gmail.com>
1 parent 40795f2 commit 876758c

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
This is a **browser extension** (Chrome/Firefox/Edge) built with WXT + React + TypeScript. There is no backend server or database. All API calls go directly from the browser to GitHub's GraphQL API.
6+
7+
### Quick reference
8+
9+
| Task | Command |
10+
|------|---------|
11+
| Install deps | `pnpm install` |
12+
| Dev server (hot reload) | `pnpm dev` |
13+
| Production build | `pnpm build` |
14+
| Type check (only CI validation) | `pnpm typecheck` |
15+
16+
### Key caveats
17+
18+
- **Node.js 25** is required (matches CI). Use `nvm use 25` if multiple versions are installed.
19+
- **pnpm 10.32.1** is specified in `packageManager`; install via `npm install --global pnpm@10.32.1`.
20+
- **No test framework** exists — there are no unit/integration tests. `pnpm typecheck` is the only automated validation.
21+
- `pnpm dev` starts the WXT dev server on port 3000 and auto-opens a Chromium browser with the extension loaded. In headless/cloud environments the auto-opened browser may not be visible; load the built extension manually via `chrome://extensions` → "Load unpacked" → `dist/chrome-mv3` (prod build) or `dist/chrome-mv3-dev` (dev build).
22+
- The `postinstall` script runs `wxt prepare` which generates `.wxt/` types required by `tsconfig.json`. If typecheck fails after a fresh clone, re-run `pnpm install`.
23+
- Styled-components warnings about unknown props (`sx`, `alignItems`, etc.) in the dev console are pre-existing and harmless — they come from `@primer/react` internals.

0 commit comments

Comments
 (0)