Skip to content

Document local clone install instead of npm/npx#33

Merged
jonatascastro12 merged 2 commits intomainfrom
devin/1777323476-fix-readme-install-instructions
Apr 27, 2026
Merged

Document local clone install instead of npm/npx#33
jonatascastro12 merged 2 commits intomainfrom
devin/1777323476-fix-readme-install-instructions

Conversation

@jonatascastro12
Copy link
Copy Markdown
Collaborator

Description

The package isn't published to npm yet, so npx workos-migrate and npm install -g workos-migrations from the README don't actually work. This PR rewrites the Installation/Quick Start sections to document a clone + npm install + npm run build flow, with an optional npm link step for getting the workos-migrate binary on your PATH. Other command examples in the README continue to use workos-migrate ... since they assume you've run npm link.

Also bumps the documented Node.js prerequisite from 18+ to 22.11+ to match package.json's engines field after the recent @workos-inc/node v9 upgrade.

Checklist

  • I have run npm run lint, npm run typecheck, npm run build, and npm test locally.
  • I have updated the README or other docs if behavior changed.
  • I have added or updated tests if appropriate.

Link to Devin session: https://app.devin.ai/sessions/cd1e4acd3b06431e8e186627c30aa667
Requested by: @jonatascastro12

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>
@devin-ai-integration
Copy link
Copy Markdown
Contributor

Original prompt from jonatas

SYSTEM:
=== BEGIN THREAD HISTORY (in #ask-it-support) ===
Jônatas Santos (U03P1SWJ8UE): 👋 Can we make this <https://github.com/workos/workos-migrations|repository> public? Working with <#C083VNBANAE> to publish some tooling that has been used on migrations.

workos/workos-migrations

Jônatas Santos (U03P1SWJ8UE): cc @Zachary Burrage (U080KR3CHB8)

Matt Peake (U09CL39TENP): Hi @Jônatas Santos (U03P1SWJ8UE) and @Zachary Burrage (U080KR3CHB8)! Could you work through the requirements here: <https://www.notion.so/workos/How-we-ship-public-facing-repositories-182d458aea8b80f29876d1895726d1c5?source=copy_link> prior to this repo going public?

I think most things are in place, but if we could get a codeowners in at least, that would be helpful. 🙂

Jônatas Santos (U03P1SWJ8UE): @Devin can you help with that?

<most_recent_message>
Jônatas Santos (U03P1SWJ8UE): @Devin can you help with that?
</most_recent_message>
=== END THREAD HISTORY ===

Thread URL: https://work-os.slack.com/archives/C0759EXUJ31/p1776972742658929?thread_ts=1776972742.658929&amp;cid=C0759EXUJ31

The latest message is the one right above that tagged you. The <most_recent_message> is the message that you should use to guide your goals + task for this session, and you should use the rest of the slack thread as context.

@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Comment thread README.md

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
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep the Quick Start, we just need to change npx workos-migrate -> npx workos/workos-migrate

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@jonatascastro12 jonatascastro12 merged commit 5efb98c into main Apr 27, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant