Skip to content

Commit 358c649

Browse files
committed
docs: add project context examples
1 parent 58eb3e5 commit 358c649

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,14 @@ Run the CLI tool against your `.ipa` or `.app` path:
9797
voc --app path/to/YourApp.ipa
9898
```
9999

100+
Include a project file for deeper analysis:
101+
102+
```bash
103+
voc --app path/to/YourApp.ipa --project path/to/YourProject.xcodeproj
104+
# or
105+
voc --app path/to/YourApp.ipa --project path/to/YourWorkspace.xcworkspace
106+
```
107+
100108
Bootstrap an `AGENTS.md` file for AI agent workflows:
101109

102110
```bash

apps/backend/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ curl -X POST http://127.0.0.1:7070/api/v1/scan \
2020
-F "profile=full"
2121
```
2222

23+
Include project context (zip a `.xcodeproj` or `.xcworkspace`):
24+
25+
```bash
26+
zip -r YourProject.zip YourProject.xcodeproj
27+
28+
curl -X POST http://127.0.0.1:7070/api/v1/scan \
29+
-F "bundle=@/path/to/YourApp.ipa" \
30+
-F "project=@/path/to/YourProject.zip" \
31+
-F "profile=full"
32+
```
33+
2334
## API
2435

2536
`POST /api/v1/scan`

0 commit comments

Comments
 (0)