Document local clone install instead of npm/npx#33
Conversation
The package isn't published to npm yet, so npx workos-migrate and npm install -g workos-migrations don't work. Document a clone + npm install + npm run build flow with optional npm link, and bump the prerequisite Node.js version to match engines. Co-Authored-By: jonatas <jonatascastro12@gmail.com>
Original prompt from jonatas
|
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
|
||
| A CLI tool for migrating users from identity providers into WorkOS. Supports Auth0, Clerk, Firebase Auth, and custom CSV imports with password hashes, organization memberships, roles, and TOTP MFA factors. | ||
|
|
||
| ## Quick Start |
There was a problem hiding this comment.
Keep the Quick Start, we just need to change npx workos-migrate -> npx workos/workos-migrate
There was a problem hiding this comment.
Restored Quick Start at the top and switched to npx workos/workos-migrations <command> (the GitHub shorthand — npx <user>/<repo> clones the repo and runs the registered bin, so it works without publishing to npm). I used workos/workos-migrations (the actual repo name) instead of workos/workos-migrate from your suggestion since the latter doesn't resolve to a GitHub repo.
Verified locally: npx workos/workos-migrations --help lists all commands.
Co-Authored-By: jonatas <jonatascastro12@gmail.com>
Description
The package isn't published to npm yet, so
npx workos-migrateandnpm install -g workos-migrationsfrom the README don't actually work. This PR rewrites the Installation/Quick Start sections to document a clone +npm install+npm run buildflow, with an optionalnpm linkstep for getting theworkos-migratebinary on yourPATH. Other command examples in the README continue to useworkos-migrate ...since they assume you've runnpm link.Also bumps the documented Node.js prerequisite from 18+ to 22.11+ to match
package.json'senginesfield after the recent@workos-inc/nodev9 upgrade.Checklist
npm run lint,npm run typecheck,npm run build, andnpm testlocally.Link to Devin session: https://app.devin.ai/sessions/cd1e4acd3b06431e8e186627c30aa667
Requested by: @jonatascastro12