@@ -5,13 +5,16 @@ CLI for searching, managing, and configuring AI-ready documentation on Yavy.
55## Commands
66
77``` bash
8- pnpm install # Install dependencies
9- pnpm run build # Build with tsup
10- pnpm run dev # Build in watch mode
11- pnpm test # Run tests (vitest)
12- pnpm run typecheck # Type check without emitting
13- pnpm run format:check # Check formatting (prettier)
14- pnpm run format # Fix formatting
8+ npm install # Install dependencies
9+ npm run build # Build with tsup
10+ npm run dev # Build in watch mode
11+ npm run check # Run all checks (typecheck + lint + format + test)
12+ npm run typecheck # TypeScript strict type checking
13+ npm run lint # ESLint with typescript-eslint
14+ npm run lint:fix # ESLint auto-fix
15+ npm run test # Run tests (vitest)
16+ npm run format:check # Check formatting (prettier)
17+ npm run format # Fix formatting
1518```
1619
1720## Architecture
@@ -28,6 +31,8 @@ See [docs/architecture.md](docs/architecture.md) for details.
2831## Key Design Decisions
2932
3033- ` @/ ` path aliases throughout (configured in tsconfig, tsup, vitest).
34+ - Strict TypeScript: ` strict ` , ` noUncheckedIndexedAccess ` , ` noUnusedLocals ` , ` noUnusedParameters ` , ` noFallthroughCasesInSwitch ` .
35+ - ESLint with typescript-eslint: ` consistent-type-imports ` , ` no-floating-promises ` , ` no-explicit-any ` .
3136- Commands set ` process.exitCode ` instead of calling ` process.exit() ` directly - keeps code testable.
3237- Two auth patterns coexist: OAuth (login flow) and token-based (API token via env or config file).
3338- Interactive mode activates when required CLI flags are missing; flags always take precedence.
0 commit comments