Skip to content

docs: add AGENTS.md with Cursor Cloud dev environment notes #4

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

docs: add AGENTS.md with Cursor Cloud dev environment notes #4

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

## Cursor Cloud specific instructions

Secure File Manager is an Android (Kotlin) file-manager app (single `app` module).
Standard commands and architecture live in `README.md`, `docs/`, `CONTRIBUTING.md`,
and `.github/workflows/ci.yml`.

The Cloud VM is already provisioned: OpenJDK 17 and 21, the Android SDK at
`$HOME/android-sdk` (env vars exported in `~/.bashrc`), and a generated
`local.properties` (gitignored) with `sdk.dir`.

- **JDK: use 17.** CI builds this app with Temurin 17. Run Gradle with
`JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64`.
- **Build (debug APK):** `./gradlew :app:assembleDebug -Psecurefilemanager.devAbi=arm64-v8a --no-daemon`
→ `app/build/outputs/apk/debug/secure-file-manager-debug.apk` (applicationId has a
`.debug` suffix; label "Secure File Manager Beta").
- **Unit tests:** `./gradlew test --no-daemon` (fast).
- **Lint:** `./gradlew :app:lintDebug --no-daemon`. Note the repo currently has
pre-existing lint findings (117 errors / 228 warnings), so `lintDebug` aborts with a
non-zero exit by design; the reports under `app/build/reports/lint-results-debug.*`
are still generated. This is lint working, not an environment failure.

Non-obvious caveats:
- `compileSdk`/`targetSdk` are **37**; installed SDK platforms are `android-37.0` /
`android-37.1` (no plain `platforms;android-37`). AGP 9.1.1 handles this — do not change it.
- Headless VM with **no `/dev/kvm`** → no Android emulator. Verify via unit tests and by
inspecting the built APK (`$ANDROID_SDK_ROOT/build-tools/37.0.0/aapt dump badging <apk>`).
Loading