Skip to content

Add AGENTS.md for Cursor Cloud development environment #6

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

Add AGENTS.md for Cursor Cloud development environment #6

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

## Cursor Cloud specific instructions

This is a Cursor fork of ripgrep (`rg`), a Rust CLI tool (no web server or ports). Version: `15.1.0-cursor4`.

### Rust toolchain

- Requires **Rust 1.85+** (edition 2024). The VM's default Rust may be older; the update script handles installing the correct version.

### System dependencies

Tests for compressed-file searching require: `zsh`, `xz-utils`, `liblz4-tool`, `musl-tools`, `brotli`, `zstd`, `g++`. These are installed by the update script.

### Key commands

| Task | Command |
|------|---------|
| Build | `cargo build` |
| Test | `cargo test --all` |
| Lint | `cargo clippy --all` |
| Run | `cargo run -- <args>` or `./target/debug/rg <args>` |

### Notes

- This is a pure Rust/Cargo workspace with 9 library crates under `crates/` and the binary at `crates/core/main.rs`.
- `cargo clippy --all` produces ~64 style warnings (pre-existing); these are not errors.
- The optional `pcre2` feature (`cargo build --features pcre2`) requires `libpcre2` C library; it is not needed for default builds.
- Integration tests are at `tests/tests.rs`; unit tests are in each crate.
Loading