Skip to content

Add Cursor Cloud specific instructions to AGENTS.md#979

Draft
devxpy wants to merge 1 commit into
masterfrom
cursor/env-setup-af36
Draft

Add Cursor Cloud specific instructions to AGENTS.md#979
devxpy wants to merge 1 commit into
masterfrom
cursor/env-setup-af36

Conversation

@devxpy

@devxpy devxpy commented May 14, 2026

Copy link
Copy Markdown
Member

Adds a ## Cursor Cloud specific instructions section to AGENTS.md with development environment documentation for future cloud agents:

  • Architecture overview (FastAPI + Remix + Celery + PostgreSQL + Redis + RabbitMQ)
  • Service startup commands
  • Python/Node environment details (pyenv 3.10.12, nvm Node 20, Poetry)
  • Lint and test commands
  • Gotchas (pre-existing ruff errors, fixture download requirement, .venv semantics, async test caveats)
Open in Web Open in Cursor 

Co-authored-by: Dev Aggarwal <devxpy@gmail.com>
@coderabbitai

coderabbitai Bot commented May 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds a new "Cursor Cloud specific instructions" section to AGENTS.md. The documentation covers the Cursor Cloud system architecture (FastAPI, Django, Node, Remix, Celery, and infrastructure components), startup procedures for all background services, environment setup notes for Python and Node developers, lint/test/typecheck commands, and critical gotchas including .venv handling, pre-existing ruff failures, a required fixture.json file, async test constraints, and the necessity of serviceAccountKey.json for application startup.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description clearly explains the additions to AGENTS.md but does not include the required Q/A checklist and legal boilerplate sections from the repository's description template. Add the Q/A checklist and legal boilerplate sections from the repository template to ensure compliance with project standards.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and clearly summarizes the main change: adding Cursor Cloud specific instructions to AGENTS.md, which aligns with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Line 79: Replace the contradictory sentence about `.venv` with a clear,
accurate statement: remove the claim that `pyenv local` creates a `.venv` file
and instead state that `.venv` in this repo is either a virtualenv directory or
a file containing the virtualenv name (per the Code Style section), and for
Cursor Cloud instructions specify which case applies—e.g., if Cloud uses a
virtualenv dir, tell users to invoke /workspace/.venv/bin/python, otherwise
instruct them to run `poetry run` or read the virtualenv name from the `.venv`
file; correct the reference to `pyenv local` to mention it creates
`.python-version` if that context is needed.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9712d1dc-bb75-4b30-b73c-397d092d64de

📥 Commits

Reviewing files that changed from the base of the PR and between f2cb98e and a89c221.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md

### Gotchas

- The `.venv` file at repo root is created by `pyenv local` (contains `3.10.12`), not a virtualenv name as described in Code Style. In Cloud, use `/workspace/.venv/bin/python` directly or `poetry run`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical | ⚖️ Poor tradeoff

Critical: Contradictory .venv documentation.

This line contains a logical contradiction and conflicts with the Code Style section:

  1. Internal contradiction: States .venv file is "created by pyenv local (contains 3.10.12)" but then instructs to use /workspace/.venv/bin/python. If .venv were a file containing 3.10.12, the path /workspace/.venv/bin/python cannot exist.

  2. Conflicts with lines 13-16: The Code Style section documents that .venv may be a virtualenv directory OR a file containing the virtualenv name. This line introduces a third case (file containing Python version) that doesn't align with either.

  3. Technical accuracy: pyenv local 3.10.12 creates .python-version, not .venv.

Based on learnings, .venv semantics in this repo are: directory containing virtualenv OR file containing virtualenv name. This Cursor Cloud-specific note needs to clarify which case applies, or if Cloud uses a different setup entirely.

📝 Suggested clarification
-The `.venv` file at repo root is created by `pyenv local` (contains `3.10.12`), not a virtualenv name as described in Code Style. In Cloud, use `/workspace/.venv/bin/python` directly or `poetry run`.
+In Cursor Cloud, `.venv` is a virtualenv directory at `/workspace/.venv/` (not a file containing a virtualenv name as described in Code Style). Python 3.10.12 is set via `pyenv local`, which creates `.python-version`. Use `/workspace/.venv/bin/python` directly or `poetry run`.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@AGENTS.md` at line 79, Replace the contradictory sentence about `.venv` with
a clear, accurate statement: remove the claim that `pyenv local` creates a
`.venv` file and instead state that `.venv` in this repo is either a virtualenv
directory or a file containing the virtualenv name (per the Code Style section),
and for Cursor Cloud instructions specify which case applies—e.g., if Cloud uses
a virtualenv dir, tell users to invoke /workspace/.venv/bin/python, otherwise
instruct them to run `poetry run` or read the virtualenv name from the `.venv`
file; correct the reference to `pyenv local` to mention it creates
`.python-version` if that context is needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants