Skip to content

Add AGENTS.md with Cursor Cloud development instructions #1

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
Muki182 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add AGENTS.md with Cursor Cloud development instructions #1

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

## Cursor Cloud specific instructions

### Project overview

工具兔 (ToolRabbit) is a single-file static website (`index.html`) providing 20+ client-side browser tools (JSON formatter, password generator, Base64, etc.). No build system, no package manager, no backend.

### Running the development server

```bash
cd /workspace && python3 -m http.server 8080
```

Open `http://localhost:8080/` in a browser. All tools run entirely client-side.

### Lint / Test / Build

- **No build step** — the site is a single `index.html` file served as-is.
- **No automated tests** — validate changes by opening the site in a browser and manually testing the affected tool(s).
- **No linter configured** — use standard HTML/CSS/JS best practices.

### Deployment

GitHub Pages via `.github/workflows/deploy.yml` — pushes to `main` auto-deploy.

### Gotchas

- Some browser APIs (`navigator.clipboard`, `crypto.subtle`) require a secure context (`https://` or `localhost`). Always serve via HTTP server, not `file://`.
- Two tools use external APIs: QR code generation (`api.qrserver.com`) and IP lookup (`api.ipify.org`). These need internet access; all other tools work offline.