Skip to content

docs: add AGENTS.md with Cursor Cloud specific setup instructions #57

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
PiotrWodecki merged 1 commit into from
Jul 3, 2026
+10 −0
Merged

docs: add AGENTS.md with Cursor Cloud specific setup instructions #57

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

Fishjam protobuf definitions, managed with `buf`.

## Cursor Cloud specific instructions

`buf` is pre-installed (via `mise`). Non-obvious notes:

- Validated: `buf lint`, `buf build`, `buf format` (all pass on `fishjam/`).
- `prepare.sh` regenerates docs and the Elixir bindings; it uses Docker (`pseudomuto/protoc-gen-doc`) and `fishjam_protos/compile_proto.sh` needs `protoc` with the Elixir plugin plus the Elixir toolchain from `fishjam_protos/.tool-versions`. Those codegen steps are not required just to lint/build the protos.
Loading