Skip to content

Commit 41df13b

Browse files
authored
docs: update documentation for recent changes (#29)
* docs: update documentation for recent changes - Add --direct flag to README CLI options - Fix file paths in DEVELOPMENT.md and CLAUDE.md (bin.ts, cli.config.ts now in src/) - Fix command references (workos, not workos-installer) - Add new auth files to project structure (credential-proxy, ensure-auth, background-refresh) * docs: add conventional commit guidelines to CLAUDE.md Ensures AI assistants use proper commit format for release-please automation.
1 parent 574cc42 commit 41df13b

3 files changed

Lines changed: 29 additions & 7 deletions

File tree

CLAUDE.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,23 @@ AI-powered CLI installer that automatically installs WorkOS AuthKit into web pro
77
```
88
installer/
99
├── src/
10+
│ ├── bin.ts # CLI entry point
11+
│ ├── cli.config.ts # App configuration (model, URLs, etc.)
1012
│ ├── run.ts # Entry point, orchestrates installer flow
1113
│ ├── lib/
1214
│ │ ├── agent-interface.ts # Claude Agent SDK integration
1315
│ │ ├── agent-runner.ts # Builds prompts, runs agent
1416
│ │ ├── config.ts # Framework detection config
15-
│ │ └── constants.ts # Integration enum, shared constants
17+
│ │ ├── constants.ts # Integration enum, shared constants
18+
│ │ ├── credential-proxy.ts # Token refresh proxy for long sessions
19+
│ │ └── ensure-auth.ts # Startup auth guard with token refresh
1620
│ ├── dashboard/ # Ink/React TUI components
1721
│ ├── nextjs/ # Next.js installer agent
1822
│ ├── react/ # React SPA installer agent
1923
│ ├── react-router/ # React Router installer agent
2024
│ ├── tanstack-start/ # TanStack Start installer agent
2125
│ └── vanilla-js/ # Vanilla JS installer agent
22-
├── bin.ts # CLI entry point
23-
└── cli.config.ts # App configuration (model, URLs, etc.)
26+
└── ...
2427
```
2528

2629
## Key Architecture
@@ -66,6 +69,21 @@ The dashboard code lives in `src/dashboard/` and uses `InstallerEventEmitter` to
6669
- **Ink + React 19** for TUI dashboard
6770
- **Never commit the `docs/` directory** - it contains local ideation artifacts
6871

72+
## Commit Conventions
73+
74+
Use [Conventional Commits](https://www.conventionalcommits.org/) - release-please auto-generates changelog from these.
75+
76+
```
77+
feat: add new feature → minor version bump, appears in changelog
78+
fix: correct bug → patch version bump, appears in changelog
79+
docs: update readme → no version bump
80+
chore: update deps → no version bump
81+
refactor: restructure code → no version bump
82+
refactor!: breaking change → major version bump (or minor if pre-1.0)
83+
```
84+
85+
Breaking changes: add `!` after type (e.g., `feat!:`) or include `BREAKING CHANGE:` in body.
86+
6987
## Commands
7088

7189
```bash

DEVELOPMENT.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
```
66
installer/
77
├── src/
8+
│ ├── bin.ts # CLI entry point
9+
│ ├── cli.config.ts # App configuration (model, URLs)
810
│ ├── run.ts # Entry point
911
│ ├── lib/
1012
│ │ ├── agent-runner.ts # Core agent execution
@@ -14,6 +16,9 @@ installer/
1416
│ │ ├── framework-config.ts # Framework definitions
1517
│ │ ├── constants.ts # Integration types
1618
│ │ ├── events.ts # InstallerEventEmitter
19+
│ │ ├── credential-proxy.ts # Token refresh proxy for long sessions
20+
│ │ ├── ensure-auth.ts # Startup auth guard
21+
│ │ ├── background-refresh.ts # Background token refresh
1722
│ │ └── adapters/ # CLI and dashboard adapters
1823
│ ├── commands/ # Subcommands (install-skill, login, logout)
1924
│ ├── steps/ # Installer step implementations
@@ -29,8 +34,6 @@ installer/
2934
│ ├── redact.ts # Credential redaction
3035
│ ├── package-manager.ts # Package manager detection
3136
│ └── ... # Additional utilities
32-
├── bin.ts # CLI entry point
33-
├── installer.config.ts # App configuration (model, URLs)
3437
├── tsconfig.json # TypeScript config
3538
└── package.json # Dependencies and scripts
3639
```
@@ -53,7 +56,7 @@ pnpm dev
5356

5457
# Test locally in another project
5558
cd /path/to/test/nextjs-app
56-
workos-installer dashboard
59+
workos dashboard
5760
```
5861

5962
## Commands
@@ -141,7 +144,7 @@ export function redactCredentials(obj: any): any {
141144
**Verbose logs:**
142145

143146
```bash
144-
workos-installer --debug
147+
workos --debug
145148
```
146149

147150
**Check logs:**

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Commands:
5757
--agent, -a Target agent(s): claude-code, codex, cursor, goose
5858

5959
Options:
60+
--direct, -D Use your own Anthropic API key (bypass llm-gateway)
6061
--integration <name> Framework: nextjs, react, react-router, tanstack-start, vanilla-js
6162
--redirect-uri <uri> Custom redirect URI (defaults to framework convention)
6263
--homepage-url <url> Custom homepage URL (defaults to http://localhost:{port})

0 commit comments

Comments
 (0)