hulthe/immich-sdk
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Tweak AGENTS.md
Some checks failed
Integration Tests / integration-test (push) Failing after 2s
Details

Browse Source
This commit is contained in:
Joakim Hulthe
2026-04-14 20:32:50 +00:00
parent c39e0a5058
commit 17009cae28
1 changed files with 1 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
AGENTS.md
View File

@@ -24,19 +24,6 @@ All examples should be run using the provided wrapper script:
./scripts/run-example.sh <example_name> ./scripts/run-example.sh <example_name>
``` ```
**Available examples:**
```bash
./scripts/run-example.sh basic_usage
./scripts/run-example.sh upload_photos
./scripts/run-example.sh download_asset
./scripts/run-example.sh thumbnail
./scripts/run-example.sh search_metadata
./scripts/run-example.sh album_management
./scripts/run-example.sh timeline_browsing
./scripts/run-example.sh delete_assets
./scripts/run-example.sh server_info
```
The wrapper handles everything automatically: The wrapper handles everything automatically:
- Starts Immich containers (if not running) - Starts Immich containers (if not running)
- Creates admin user and API key - Creates admin user and API key
@@ -46,7 +33,7 @@ The wrapper handles everything automatically:
**When adding new examples:** **When adding new examples:**
1. Read `IMMICH_URL` and `IMMICH_API_KEY` from environment variables 1. Read `IMMICH_URL` and `IMMICH_API_KEY` from environment variables
2. Test with: `./scripts/run-example.sh <name>` 2. Test with: `./scripts/run-example.sh <name>` (Important!)
3. Verify it works with the seeded test data (3 photos, 1 album) 3. Verify it works with the seeded test data (3 photos, 1 album)
## Code Style Guidelines ## Code Style Guidelines