Skip to content

Add AGENTS.md with Cursor Cloud development instructions #2

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

Add AGENTS.md with Cursor Cloud development instructions #2

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

## Project Overview

**CheckList** is a scaffolded iOS to-do/checklist app built with Swift 3 and UIKit. It uses Interface Builder storyboards and Core Data (model exists but has no entities yet). The app is an early-stage Xcode project with minimal code.

### Key Files
- `CheckList/AppDelegate.swift` — App lifecycle + Core Data stack
- `CheckList/ViewController.swift` — Main view controller (scaffolded, no logic yet)
- `CheckList/Base.lproj/Main.storyboard` — Main UI storyboard
- `CheckList.xcodeproj/project.pbxproj` — Xcode project configuration

### Tech Stack
- **Language:** Swift 3
- **Framework:** UIKit
- **Data:** Core Data (empty model)
- **Build system:** Xcode (>= 8.3.2)
- **Target:** iOS 10.3, iPhone + iPad
- **Dependencies:** None (no CocoaPods, SPM, or Carthage)

## Cursor Cloud specific instructions

### Platform constraint
This is a native iOS app that **requires macOS + Xcode >= 8.3.2** to compile and run. The Cloud Agent runs Linux, so you **cannot** build (`xcodebuild`) or run this app in the iOS Simulator here.

### What you CAN do on Linux
- **Edit Swift source files** — all edits are safe; the code is standard Swift 3 / UIKit.
- **Validate project structure** — use Python to parse `Info.plist` (plistlib), storyboard XML (`xml.etree.ElementTree`), Core Data model XML, and `project.pbxproj`.
- **SwiftLint** is installed at `/usr/local/bin/swiftlint` (v0.57.1), but requires the Swift runtime (`libsourcekitdInProc.so`) to function. If Swift is installed in the future, run `swiftlint lint` from the repo root.

### What you CANNOT do on Linux
- Compile the app (`xcodebuild build`)
- Run the app in iOS Simulator
- Run unit/UI tests (`xcodebuild test`)

### Lint / Test / Build commands (on macOS)
```bash
# Build
xcodebuild -project CheckList.xcodeproj -scheme CheckList -sdk iphonesimulator build

# Test
xcodebuild -project CheckList.xcodeproj -scheme CheckList -sdk iphonesimulator -destination 'platform=iOS Simulator,name=iPhone SE' test

# Lint (if SwiftLint is installed)
swiftlint lint
```