Skip to content

Add AGENTS.md with Cursor Cloud development instructions #15

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

Merged
fathiraz merged 1 commit into from
Apr 7, 2026
Merged

Add AGENTS.md with Cursor Cloud development instructions #15

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
23 changes: 23 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# AGENTS.md

## Cursor Cloud specific instructions

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.

### Quick reference

| Task | Command |
|------|---------|
| Install deps | `pnpm install` |
| Dev server (hot reload) | `pnpm dev` |
| Production build | `pnpm build` |
| Type check (only CI validation) | `pnpm typecheck` |

### Key caveats

- **Node.js 25** is required (matches CI). Use `nvm use 25` if multiple versions are installed.
- **pnpm 10.32.1** is specified in `packageManager`; install via `npm install --global pnpm@10.32.1`.
- **No test framework** exists — there are no unit/integration tests. `pnpm typecheck` is the only automated validation.
- `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).
- 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`.
- Styled-components warnings about unknown props (`sx`, `alignItems`, etc.) in the dev console are pre-existing and harmless — they come from `@primer/react` internals.
Loading