Skip to content

Add AGENTS.md with Cloud Agent development instructions #5

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

Add AGENTS.md with Cloud Agent development instructions #5

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

## Cursor Cloud specific instructions

This is an Electron desktop app (Markdown Editor with AI). There are no backend services, databases, or Docker containers. The entire application is a single Electron process.

### Running the app

- Install dependencies: `npm install`
- Start the app: `DISPLAY=:1 npm start` (use display `:1` for the Desktop pane, or start Xvfb on `:99` for headless)
- Build for Linux: `npm run build:linux`
- See `README.md` for full build commands (mac/win/linux/all)

### Key caveats

- **Display server required**: Electron needs an X11 display. On Cloud Agent VMs, use `DISPLAY=:1` to render on the Desktop pane visible to the computerUse subagent. For headless-only validation, start Xvfb (`Xvfb :99 -screen 0 1280x1024x24 &`) and use `DISPLAY=:99`.
- **DBus errors are non-fatal**: The app logs many `dbus/bus.cc` and `dbus/object_proxy.cc` errors on headless Linux. These are cosmetic and do not affect functionality.
- **No test suite**: The project has no automated tests (`npm test` is not defined). Validation is manual via the GUI.
- **No linter configured**: There is no ESLint or other linter set up in the project.
- **AI features require configuration**: AI text transformations and chat require configuring an OpenAI-compatible API provider in Settings > Plugins. Core markdown editing works without any API keys.