Skip to content

Add AGENTS.md for Cursor Cloud development environment #1

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

Add AGENTS.md for Cursor Cloud development environment #1

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

## Cursor Cloud specific instructions

This is a Go CLI tool (disk space analyzer). No external services or databases required.

**Build & Run:**
- `go build -o godiskanal .` — builds the binary
- `./godiskanal --path <dir> --top N` — runs a scan on a given directory

**Testing:**
- `go test ./...` — runs all tests (38 tests across 5 packages)
- `go vet ./...` — static analysis / linting

**Notes:**
- The tool is designed for macOS, but builds and runs on Linux. macOS-specific features (Homebrew cache, Time Machine, iOS Simulators) gracefully degrade on Linux.
- The `--llm` flag requires an `OPENAI_API_KEY` env var or `--api-key` flag; this is optional and not needed for core scanning/browsing/cleanup functionality.
- TUI modes (`-b` for browser, `-i` for interactive cleanup) require a terminal; they use Bubble Tea and will not work in non-TTY contexts.
- No Makefile, Dockerfile, or CI config exists; the standard Go toolchain is the only build dependency.