workos 0.15.2 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/README.md +37 -11
  2. package/dist/bin.js +1439 -1257
  3. package/dist/bin.js.map +1 -1
  4. package/dist/cli.config.d.ts +1 -0
  5. package/dist/cli.config.js +1 -0
  6. package/dist/cli.config.js.map +1 -1
  7. package/dist/commands/api/index.js +7 -2
  8. package/dist/commands/api/index.js.map +1 -1
  9. package/dist/commands/api/interactive.js +9 -3
  10. package/dist/commands/api/interactive.js.map +1 -1
  11. package/dist/commands/debug.d.ts +2 -1
  12. package/dist/commands/debug.js +43 -3
  13. package/dist/commands/debug.js.map +1 -1
  14. package/dist/commands/dev.js +5 -4
  15. package/dist/commands/dev.js.map +1 -1
  16. package/dist/commands/doctor.js +13 -4
  17. package/dist/commands/doctor.js.map +1 -1
  18. package/dist/commands/emulate.js +2 -2
  19. package/dist/commands/emulate.js.map +1 -1
  20. package/dist/commands/env.js +5 -4
  21. package/dist/commands/env.js.map +1 -1
  22. package/dist/commands/install-skill.js +4 -3
  23. package/dist/commands/install-skill.js.map +1 -1
  24. package/dist/commands/install.js +2 -2
  25. package/dist/commands/install.js.map +1 -1
  26. package/dist/commands/login.js +3 -3
  27. package/dist/commands/login.js.map +1 -1
  28. package/dist/commands/migrations.d.ts +1 -1
  29. package/dist/commands/migrations.js +4 -1
  30. package/dist/commands/migrations.js.map +1 -1
  31. package/dist/commands/telemetry.d.ts +3 -0
  32. package/dist/commands/telemetry.js +88 -0
  33. package/dist/commands/telemetry.js.map +1 -0
  34. package/dist/commands/uninstall-skill.js +3 -2
  35. package/dist/commands/uninstall-skill.js.map +1 -1
  36. package/dist/commands/vault-run.d.ts +13 -0
  37. package/dist/commands/vault-run.js +194 -0
  38. package/dist/commands/vault-run.js.map +1 -0
  39. package/dist/commands/vault.d.ts +3 -2
  40. package/dist/commands/vault.js +41 -8
  41. package/dist/commands/vault.js.map +1 -1
  42. package/dist/lib/api-error-handler.d.ts +15 -3
  43. package/dist/lib/api-error-handler.js +52 -34
  44. package/dist/lib/api-error-handler.js.map +1 -1
  45. package/dist/lib/command-aliases.d.ts +8 -0
  46. package/dist/lib/command-aliases.js +12 -0
  47. package/dist/lib/command-aliases.js.map +1 -0
  48. package/dist/lib/constants.d.ts +0 -1
  49. package/dist/lib/constants.js +0 -1
  50. package/dist/lib/constants.js.map +1 -1
  51. package/dist/lib/device-id.d.ts +25 -0
  52. package/dist/lib/device-id.js +102 -0
  53. package/dist/lib/device-id.js.map +1 -0
  54. package/dist/lib/preferences.d.ts +101 -0
  55. package/dist/lib/preferences.js +198 -0
  56. package/dist/lib/preferences.js.map +1 -0
  57. package/dist/lib/run-with-core.js +15 -15
  58. package/dist/lib/run-with-core.js.map +1 -1
  59. package/dist/lib/settings.d.ts +6 -0
  60. package/dist/lib/settings.js +7 -0
  61. package/dist/lib/settings.js.map +1 -1
  62. package/dist/lib/telemetry-notice.d.ts +25 -0
  63. package/dist/lib/telemetry-notice.js +56 -0
  64. package/dist/lib/telemetry-notice.js.map +1 -0
  65. package/dist/test/force-insecure-storage.d.ts +1 -0
  66. package/dist/test/force-insecure-storage.js +9 -0
  67. package/dist/test/force-insecure-storage.js.map +1 -0
  68. package/dist/test/setup.d.ts +1 -0
  69. package/dist/test/setup.js +38 -0
  70. package/dist/test/setup.js.map +1 -0
  71. package/dist/utils/analytics.d.ts +41 -0
  72. package/dist/utils/analytics.js +199 -12
  73. package/dist/utils/analytics.js.map +1 -1
  74. package/dist/utils/box.d.ts +29 -1
  75. package/dist/utils/box.js +92 -4
  76. package/dist/utils/box.js.map +1 -1
  77. package/dist/utils/cli-exit.d.ts +15 -0
  78. package/dist/utils/cli-exit.js +11 -0
  79. package/dist/utils/cli-exit.js.map +1 -0
  80. package/dist/utils/cli-symbols.d.ts +1 -1
  81. package/dist/utils/command-telemetry.d.ts +17 -0
  82. package/dist/utils/command-telemetry.js +67 -0
  83. package/dist/utils/command-telemetry.js.map +1 -0
  84. package/dist/utils/crash-reporter.d.ts +13 -0
  85. package/dist/utils/crash-reporter.js +91 -0
  86. package/dist/utils/crash-reporter.js.map +1 -0
  87. package/dist/utils/debug.d.ts +1 -0
  88. package/dist/utils/debug.js +4 -1
  89. package/dist/utils/debug.js.map +1 -1
  90. package/dist/utils/exit-codes.d.ts +5 -0
  91. package/dist/utils/exit-codes.js +30 -1
  92. package/dist/utils/exit-codes.js.map +1 -1
  93. package/dist/utils/help-json.d.ts +6 -0
  94. package/dist/utils/help-json.js +87 -10
  95. package/dist/utils/help-json.js.map +1 -1
  96. package/dist/utils/output.d.ts +7 -2
  97. package/dist/utils/output.js +9 -2
  98. package/dist/utils/output.js.map +1 -1
  99. package/dist/utils/telemetry-client.d.ts +30 -2
  100. package/dist/utils/telemetry-client.js +122 -12
  101. package/dist/utils/telemetry-client.js.map +1 -1
  102. package/dist/utils/telemetry-store-forward.d.ts +11 -0
  103. package/dist/utils/telemetry-store-forward.js +94 -0
  104. package/dist/utils/telemetry-store-forward.js.map +1 -0
  105. package/dist/utils/telemetry-types.d.ts +58 -9
  106. package/dist/utils/telemetry-types.js.map +1 -1
  107. package/package.json +1 -1
package/README.md CHANGED
@@ -81,6 +81,9 @@ Resource Management:
81
81
  api-key Manage per-org API keys
82
82
  org-domain Manage organization domains
83
83
 
84
+ Migrations:
85
+ migrations Migrate users and SSO connections into WorkOS
86
+
84
87
  Workflows:
85
88
  seed Declarative resource provisioning from YAML
86
89
  setup-org One-shot organization onboarding
@@ -196,6 +199,27 @@ Inspects a directory's sync state, user/group counts, recent events, and detects
196
199
  workos debug-sync directory_01ABC123
197
200
  ```
198
201
 
202
+ ### Migrations
203
+
204
+ Migrate users and SSO connections from other identity providers into WorkOS. The `migrations` namespace passes through to `@workos/migrations`.
205
+
206
+ ```bash
207
+ # Interactive migration wizard
208
+ workos migrations wizard
209
+
210
+ # Export a blank CSV template
211
+ workos migrations export-template saml_connections --output saml_connections.csv
212
+ workos migrations export-template oidc_connections --output oidc_connections.csv
213
+
214
+ # Export from Auth0
215
+ workos migrations export-auth0 --domain your-tenant.auth0.com --client-id <id> --client-secret <secret>
216
+
217
+ # Import users from CSV
218
+ workos migrations import --csv users.csv
219
+ ```
220
+
221
+ Run `workos migrations --help` for all available subcommands.
222
+
199
223
  <!-- UNRELEASED: Local Development (emulator) — hidden until beta testing is complete.
200
224
  To restore, uncomment this section and re-enable the `emulate` and `dev` commands
201
225
  in src/bin.ts and src/utils/help-json.ts.
@@ -512,13 +536,14 @@ workos portal generate-link --intent <intent> --org <orgId> [--return-url] [--su
512
536
 
513
537
  ```bash
514
538
  workos vault list [--limit]
515
- workos vault get <id>
516
- workos vault get-by-name <name>
517
- workos vault create --name <name> --value <secret> [--org <orgId>]
518
- workos vault update <id> --value <secret> [--version-check]
539
+ workos vault get <id> [--decrypt]
540
+ workos vault get-by-name <name> [--decrypt]
541
+ workos vault create --name <name> --org <orgId> [--value <secret>] # omit --value to read from stdin
542
+ workos vault update <id> [--value <secret>] [--version-check] # omit --value to read from stdin
519
543
  workos vault delete <id>
520
544
  workos vault describe <id>
521
545
  workos vault list-versions <id>
546
+ workos vault run --secret ENV_VAR=vault-name [...] [--env <name>] [--dry-run] -- <command>
522
547
  ```
523
548
 
524
549
  #### api-key
@@ -712,17 +737,18 @@ OAuth credentials are stored in the system keychain (with `~/.workos/credentials
712
737
 
713
738
  ## Telemetry
714
739
 
715
- The installer collects anonymous usage telemetry to help improve the product:
740
+ The CLI collects anonymous usage telemetry to help improve the product:
741
+
742
+ - **Command events** -- command name, duration, success/failure, termination reason, and which flags were used (for telemetry-enabled commands; `install` and `dashboard` use session events instead)
743
+ - **Session events** -- framework detected, step timing, token usage (installer only)
744
+ - **Crash events** -- sanitized error type and stack trace (no secrets, truncated to 4KB)
716
745
 
717
- - Session outcome (success/error/cancelled)
718
- - Framework detected
719
- - Duration and step timing
720
- - Token usage (for capacity planning)
746
+ Environment fingerprint (OS, Node version, shell, CI detection) is included on all events. No code, credentials, or personal data is collected.
721
747
 
722
- No code, credentials, or personal data is collected. Disable with:
748
+ Disable with:
723
749
 
724
750
  ```bash
725
- WORKOS_TELEMETRY=false npx workos@latest install
751
+ WORKOS_TELEMETRY=false workos <command>
726
752
  ```
727
753
 
728
754
  ## Logs