Skip to content

Commit af7c5a4

Browse files
committed
Add AGENTS.md with Cursor Cloud specific instructions
1 parent 423ba7a commit af7c5a4

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
### Overview
6+
7+
NetGraph is a Python library + CLI tool for network modeling and analysis. It combines a Python front-end with C++ graph algorithms via `netgraph-core`. There are no web servers, databases, or Docker services.
8+
9+
### Development commands
10+
11+
All dev commands use the venv at `./venv`. See `Makefile` for the full list (`make help`).
12+
13+
| Task | Command |
14+
|---|---|
15+
| Lint (ruff + pyright) | `make lint` |
16+
| Auto-format | `make format` |
17+
| Quick tests (no slow/benchmark) | `make qt` |
18+
| Full tests with coverage | `make test` |
19+
| Run a scenario | `ngraph run scenarios/square_mesh.yaml --output results/` |
20+
| Schema validation | `make validate` |
21+
22+
### Gotchas
23+
24+
- The system package `python3.12-venv` must be installed before `make dev` can create the virtualenv. The update script handles this.
25+
- `git config core.hooksPath` may be set by the Cloud Agent environment; if pre-commit hook installation fails with "Cowardly refusing to install hooks with `core.hooksPath` set", run `git config --unset-all core.hooksPath` first.
26+
- Pyright is pinned to `1.1.401` in `pyproject.toml`; ignore "new version available" warnings.
27+
- `make test` enforces a minimum 75% code coverage threshold (currently ~89%).

0 commit comments

Comments
 (0)