Skip to content

Commit 694cd78

Browse files
Add AGENTS.md with Cursor Cloud specific instructions (#70)
Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Dominic Letz <dominicletz@users.noreply.github.com>
1 parent 1fbfde4 commit 694cd78

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
This is an **Elixir library** (not a standalone app). It provides native desktop windowing for Phoenix LiveView apps via wxWidgets.
6+
7+
### Toolchain
8+
9+
Erlang and Elixir versions are managed via `.tool-versions` (asdf format). The Cloud VM uses **mise** to resolve these. After the update script runs, `erl` and `elixir` are available on `PATH`.
10+
11+
### System dependencies
12+
13+
wxWidgets GUI support requires `libwxgtk-webview3.2-dev` and `xvfb` on headless Linux. These are pre-installed in the VM snapshot.
14+
15+
### Key commands
16+
17+
| Task | Command |
18+
|---|---|
19+
| Install deps | `mix deps.get` |
20+
| Compile | `mix compile` |
21+
| Lint (all) | `mix lint` (runs compile --warnings-as-errors, format --check-formatted, credo --ignore refactor, dialyzer) |
22+
| Tests | `xvfb-run mix test` |
23+
| Run code | `xvfb-run mix run -e '<elixir code>'` |
24+
| IEx shell | `xvfb-run iex -S mix` |
25+
26+
### Known issues
27+
28+
- **Dialyzer warnings**: `mix dialyzer` emits pre-existing warnings in `lib/mix/tasks/desktop.install.ex` related to the optional `igniter` dependency. These also fail in CI on `main`.
29+
- **Install test**: `test/mix/tasks/desktop.install_test.exs` fails because `Igniter.Test.phx_test_project/1` requires a working `mix phx.new` integration that does not fully resolve in all environments. This is pre-existing and CI does not run `mix test`.
30+
- **GLib warning**: `xvfb-run` may emit a harmless `GLib-WARNING` about `g_spawn_sync()` / `ECHILD`; this is cosmetic and can be ignored.
31+
32+
### Running without a display
33+
34+
All commands that load the `:wx` application (compile, test, iex) need a display. Use `xvfb-run` prefix on headless servers. The `NO_WX` environment variable can skip wx initialization but will limit functionality.

0 commit comments

Comments
 (0)