Skip to content

Add AGENTS.md with Cursor Cloud development instructions #85

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

Open
Ibrahimrahhal wants to merge 2 commits into
base: main
Choose a base branch
from
+21 −0
Open

Add AGENTS.md with Cursor Cloud development instructions #85

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b383679
Add AGENTS.md with Cursor Cloud development instructions
cursoragent Apr 15, 2026
176bfc1
Update AGENTS.md: add debug config persistence caveat
cursoragent Apr 15, 2026
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
21 changes: 21 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# AGENTS.md

## Cursor Cloud specific instructions

### Overview
Corgea CLI is a Rust-based command-line security scanning tool. It communicates with the Corgea SaaS platform (`https://www.corgea.app`) via REST API. There are no local databases or services to run — the CLI is a stateless client.

### Development commands
- **Build**: `cargo build`
- **Test**: `cargo test` (7 unit tests in `src/authorize.rs`)
- **Lint**: `cargo clippy` (warnings only, no errors expected)
- **Dev install** (Python wrapper): `source .venv/bin/activate && maturin develop` — builds the Rust binary and installs it as a Python package, making `corgea` available on PATH within the venv
- **Run directly**: `./target/debug/corgea` after `cargo build`

### Key caveats
- The Rust toolchain must be **stable latest** (>=1.85). The default VM ships with 1.83 which is too old for the `time-core` crate's `edition2024` feature. The update script handles `rustup default stable`.
- `python3.12-venv` system package is required for creating the `.venv` used by maturin.
- The CLI requires a `CORGEA_TOKEN` (or `corgea login <token>`) to interact with the Corgea API. Without it, commands like `corgea scan`, `corgea list`, etc. return 401. This is expected behavior — the CLI itself is still fully functional.
- `corgea login <token>` with `CORGEA_DEBUG=1` persists `debug = 1` into `~/.corgea/config.toml`. If you see debug output unexpectedly, edit that file and set `debug = 0`.
- Config is stored at `~/.corgea/config.toml`.
- Set `CORGEA_DEBUG=1` for verbose debug logging.
Loading