Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,23 @@ AI-powered CLI installer that automatically installs WorkOS AuthKit into web pro
```
installer/
├── src/
│ ├── bin.ts # CLI entry point
│ ├── cli.config.ts # App configuration (model, URLs, etc.)
│ ├── run.ts # Entry point, orchestrates installer flow
│ ├── lib/
│ │ ├── agent-interface.ts # Claude Agent SDK integration
│ │ ├── agent-runner.ts # Builds prompts, runs agent
│ │ ├── config.ts # Framework detection config
│ │ └── constants.ts # Integration enum, shared constants
│ │ ├── constants.ts # Integration enum, shared constants
│ │ ├── credential-proxy.ts # Token refresh proxy for long sessions
│ │ └── ensure-auth.ts # Startup auth guard with token refresh
│ ├── dashboard/ # Ink/React TUI components
│ ├── nextjs/ # Next.js installer agent
│ ├── react/ # React SPA installer agent
│ ├── react-router/ # React Router installer agent
│ ├── tanstack-start/ # TanStack Start installer agent
│ └── vanilla-js/ # Vanilla JS installer agent
├── bin.ts # CLI entry point
└── cli.config.ts # App configuration (model, URLs, etc.)
└── ...
```

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

## Commit Conventions

Use [Conventional Commits](https://www.conventionalcommits.org/) - release-please auto-generates changelog from these.

```
feat: add new feature → minor version bump, appears in changelog
fix: correct bug → patch version bump, appears in changelog
docs: update readme → no version bump
chore: update deps → no version bump
refactor: restructure code → no version bump
refactor!: breaking change → major version bump (or minor if pre-1.0)
```

Breaking changes: add `!` after type (e.g., `feat!:`) or include `BREAKING CHANGE:` in body.

## Commands

```bash
Expand Down
11 changes: 7 additions & 4 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
```
installer/
├── src/
│ ├── bin.ts # CLI entry point
│ ├── cli.config.ts # App configuration (model, URLs)
│ ├── run.ts # Entry point
│ ├── lib/
│ │ ├── agent-runner.ts # Core agent execution
Expand All @@ -14,6 +16,9 @@ installer/
│ │ ├── framework-config.ts # Framework definitions
│ │ ├── constants.ts # Integration types
│ │ ├── events.ts # InstallerEventEmitter
│ │ ├── credential-proxy.ts # Token refresh proxy for long sessions
│ │ ├── ensure-auth.ts # Startup auth guard
│ │ ├── background-refresh.ts # Background token refresh
│ │ └── adapters/ # CLI and dashboard adapters
│ ├── commands/ # Subcommands (install-skill, login, logout)
│ ├── steps/ # Installer step implementations
Expand All @@ -29,8 +34,6 @@ installer/
│ ├── redact.ts # Credential redaction
│ ├── package-manager.ts # Package manager detection
│ └── ... # Additional utilities
├── bin.ts # CLI entry point
├── installer.config.ts # App configuration (model, URLs)
├── tsconfig.json # TypeScript config
└── package.json # Dependencies and scripts
```
Expand All @@ -53,7 +56,7 @@ pnpm dev

# Test locally in another project
cd /path/to/test/nextjs-app
workos-installer dashboard
workos dashboard
```

## Commands
Expand Down Expand Up @@ -141,7 +144,7 @@ export function redactCredentials(obj: any): any {
**Verbose logs:**

```bash
workos-installer --debug
workos --debug
```

**Check logs:**
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Commands:
--agent, -a Target agent(s): claude-code, codex, cursor, goose

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