You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+24-7Lines changed: 24 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,27 @@
3
3
## Package manager
4
4
- Use `pnpm` for all package management
5
5
6
-
## Commands
7
-
-`pnpm test` — run all tests (AVA, serial)
6
+
## Setup and Commands
7
+
8
+
### Initial Setup Checklist
9
+
1. Create a `.env` file in the project root (loaded via `dotenv/config`)
10
+
2. Verify all required environment variables are set and non-empty:
11
+
-`VRCHAT_EMAIL`
12
+
-`VRCHAT_USERNAME`
13
+
-`VRCHAT_PASSWORD`
14
+
-`VRCHAT_TOTP_SECRET`
15
+
-`VRCHAT_FRIEND_ID`
16
+
-`VRCHAT_GROUP_ID`
17
+
-**If any variable is missing, empty, or malformed, stop immediately and print the exact variable names that must be set before any test run.**
18
+
3. Before every local test run, execute `pnpm test:clean` first. Do not reuse any existing `data/state/` or AVA cache from a previous run. (CI does this automatically.)
19
+
4. Execute `pnpm get-spec` to download the latest `openapi-internal+legacy.yaml` to `openapi.yaml` (CI does this automatically).
20
+
21
+
### Available Commands
22
+
-`pnpm test` — run all tests (AVA; serial mode configured in `ava.config.js`)
8
23
-`pnpm fast-fail` — stop on first failure
9
24
-`pnpm type-check` — TypeScript type check
10
25
-`pnpm test:clean` — clear `data/state` and AVA cache (`pwsh ./scripts/clean.ps1`)
26
+
-`pnpm get-spec` — download latest `openapi-internal+legacy.yaml` to `openapi.yaml`
11
27
12
28
## Project purpose
13
29
Integration-test suite against the live VRChat API. Downloads the latest `openapi-internal+legacy.yaml` from vrchatapi/specification releases, then validates actual API responses against the schema.
@@ -19,12 +35,11 @@ Integration-test suite against the live VRChat API. Downloads the latest `openap
19
35
- Test results recorded as markdown to `data/requests/`
20
36
21
37
## Running tests
22
-
Requires these env vars (add to `.env` — loaded via `dotenv/config`):
- Rate-limit protection: 200ms between requests, exponential backoff up to 10 retries on 429
42
+
-**If login fails, TOTP verification fails, or cookie-based reuse cannot be established, abort the run immediately with a clear error message and do not continue with partial state.**
0 commit comments