-
Notifications
You must be signed in to change notification settings - Fork 7
docs: Add migrations command to README #161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -81,6 +81,9 @@ Resource Management: | |
| api-key Manage per-org API keys | ||
| org-domain Manage organization domains | ||
|
|
||
| Migrations: | ||
| migrations Migrate users and SSO connections into WorkOS | ||
|
|
||
| Workflows: | ||
| seed Declarative resource provisioning from YAML | ||
| setup-org One-shot organization onboarding | ||
|
|
@@ -196,6 +199,27 @@ Inspects a directory's sync state, user/group counts, recent events, and detects | |
| workos debug-sync directory_01ABC123 | ||
| ``` | ||
|
|
||
| ### Migrations | ||
|
|
||
| Migrate users and SSO connections from other identity providers into WorkOS. The `migrations` namespace passes through to `@workos/migrations`. | ||
|
|
||
| ```bash | ||
| # Interactive migration wizard | ||
| workos migrations wizard | ||
|
|
||
| # Export a blank CSV template | ||
| workos migrations export-template saml_connections --output saml_connections.csv | ||
| workos migrations export-template oidc_connections --output oidc_connections.csv | ||
|
|
||
| # Export from Auth0 | ||
| workos migrations export-auth0 --domain your-tenant.auth0.com --client-id <id> --client-secret <secret> | ||
|
|
||
| # Import users from CSV | ||
|
Comment on lines
+216
to
+217
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
The
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch — fixed in the latest commit. Changed to |
||
| workos migrations import --csv users.csv | ||
| ``` | ||
|
|
||
| Run `workos migrations --help` for all available subcommands. | ||
|
|
||
| <!-- UNRELEASED: Local Development (emulator) — hidden until beta testing is complete. | ||
| To restore, uncomment this section and re-enable the `emulate` and `dev` commands | ||
| in src/bin.ts and src/utils/help-json.ts. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
export-templateis not a documented subcommand of@workos/migrationsThe
@workos/migrationspackage lists its subcommands as:wizard,export-auth0,export-cognito,merge-passwords,transform-clerk,transform-firebase,validate,import,import-package,analyze,enroll-totp, andprocess-role-definitions.export-templatedoes not appear in that list, nor does it appear in the spec file. Runningworkos migrations export-template ...as documented would likely result in an unknown command error.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
export-templatedoes exist — it was added in workos-migrations#90 (merged). Seesrc/cli/commands/export-template.tsandsrc/cli/index.tsin the@workos/migrationsrepo. Greptile is likely looking at a stale snapshot of the codebase.