From 5cee5c1bdf6fc25a6181eebe48c45d0c5337cb10 Mon Sep 17 00:00:00 2001 From: Nick Nisi Date: Fri, 30 Jan 2026 21:29:51 -0600 Subject: [PATCH 1/2] 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) --- CLAUDE.md | 9 ++++++--- DEVELOPMENT.md | 11 +++++++---- README.md | 1 + 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 20bce88..cd613f2 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -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 diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 024b882..e666544 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -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 @@ -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 @@ -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 ``` @@ -53,7 +56,7 @@ pnpm dev # Test locally in another project cd /path/to/test/nextjs-app -workos-installer dashboard +workos dashboard ``` ## Commands @@ -141,7 +144,7 @@ export function redactCredentials(obj: any): any { **Verbose logs:** ```bash -workos-installer --debug +workos --debug ``` **Check logs:** diff --git a/README.md b/README.md index f50e247..d86d17c 100644 --- a/README.md +++ b/README.md @@ -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 Framework: nextjs, react, react-router, tanstack-start, vanilla-js --redirect-uri Custom redirect URI (defaults to framework convention) --homepage-url Custom homepage URL (defaults to http://localhost:{port}) From 22f93eeb47eadf401051b074305d55fe2f0b482e Mon Sep 17 00:00:00 2001 From: Nick Nisi Date: Fri, 30 Jan 2026 21:30:51 -0600 Subject: [PATCH 2/2] docs: add conventional commit guidelines to CLAUDE.md Ensures AI assistants use proper commit format for release-please automation. --- CLAUDE.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index cd613f2..4c41ebf 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -69,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