Skip to content

Commit cb94e80

Browse files
cursoragentkiyarose
andcommitted
Add AGENTS.md with Cursor Cloud development instructions
Co-authored-by: Kiya Rose Ren-Miyakari <kiya.rose@sillylittle.tech>
1 parent 777cd26 commit cb94e80

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
### Project overview
6+
7+
PinStick is a lightweight desktop note-pinning app with two implementations:
8+
- **Native macOS app** — Swift/SwiftUI (cannot build on Linux)
9+
- **Cross-platform app** — Tauri 1.5 (Rust + HTML/CSS/JS) under `cross-platform/`
10+
11+
Cloud agents work exclusively with the **cross-platform Tauri app** since the macOS native app requires Xcode/macOS.
12+
13+
### Running the cross-platform app
14+
15+
```bash
16+
cd cross-platform
17+
npm install
18+
npx tauri dev # development mode with hot-reload
19+
npm run build # production build (outputs .deb and .AppImage)
20+
npm run check # debug build without bundling (fast compile check)
21+
```
22+
23+
### Linting and formatting
24+
25+
```bash
26+
cd cross-platform/src-tauri
27+
cargo clippy # Rust linter
28+
cargo fmt --check # Rust format check
29+
```
30+
31+
There is no JavaScript linter configured (the frontend is vanilla JS with no ESLint).
32+
33+
### Key caveats (Ubuntu 24.04 / Noble)
34+
35+
- **webkit2gtk-4.0 is unavailable** on Ubuntu 24.04. Tauri 1.5 requires it, but only `webkit2gtk-4.1` ships with Noble. The update script installs the 4.1 packages and creates pkg-config shims (`webkit2gtk-4.0.pc`, `javascriptcoregtk-4.0.pc`) plus library symlinks (`libwebkit2gtk-4.0.so``libwebkit2gtk-4.1.so`, etc.) to satisfy the build.
36+
- **Rust stable must be the default toolchain.** The pre-installed pinned version (1.83) is too old; `rustup default stable` switches to the latest stable (1.95+), which supports `edition2024` required by transitive dependencies.
37+
- The Tauri dev server emits a harmless deprecation warning: `webkit_settings_set_enable_offline_web_application_cache is deprecated and does nothing.` — this is safe to ignore.
38+
39+
### Tests
40+
41+
There are no automated tests for the cross-platform Tauri app. The native macOS app has `JotTests.swift` and `JotUITests.swift` but these cannot run on Linux.
42+
43+
Manual testing: launch the app with `npx tauri dev` (requires an X11 display) and verify the note textarea and pin button work.

0 commit comments

Comments
 (0)