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.
- package/README.md +37 -11
- package/dist/bin.js +1439 -1257
- package/dist/bin.js.map +1 -1
- package/dist/cli.config.d.ts +1 -0
- package/dist/cli.config.js +1 -0
- package/dist/cli.config.js.map +1 -1
- package/dist/commands/api/index.js +7 -2
- package/dist/commands/api/index.js.map +1 -1
- package/dist/commands/api/interactive.js +9 -3
- package/dist/commands/api/interactive.js.map +1 -1
- package/dist/commands/debug.d.ts +2 -1
- package/dist/commands/debug.js +43 -3
- package/dist/commands/debug.js.map +1 -1
- package/dist/commands/dev.js +5 -4
- package/dist/commands/dev.js.map +1 -1
- package/dist/commands/doctor.js +13 -4
- package/dist/commands/doctor.js.map +1 -1
- package/dist/commands/emulate.js +2 -2
- package/dist/commands/emulate.js.map +1 -1
- package/dist/commands/env.js +5 -4
- package/dist/commands/env.js.map +1 -1
- package/dist/commands/install-skill.js +4 -3
- package/dist/commands/install-skill.js.map +1 -1
- package/dist/commands/install.js +2 -2
- package/dist/commands/install.js.map +1 -1
- package/dist/commands/login.js +3 -3
- package/dist/commands/login.js.map +1 -1
- package/dist/commands/migrations.d.ts +1 -1
- package/dist/commands/migrations.js +4 -1
- package/dist/commands/migrations.js.map +1 -1
- package/dist/commands/telemetry.d.ts +3 -0
- package/dist/commands/telemetry.js +88 -0
- package/dist/commands/telemetry.js.map +1 -0
- package/dist/commands/uninstall-skill.js +3 -2
- package/dist/commands/uninstall-skill.js.map +1 -1
- package/dist/commands/vault-run.d.ts +13 -0
- package/dist/commands/vault-run.js +194 -0
- package/dist/commands/vault-run.js.map +1 -0
- package/dist/commands/vault.d.ts +3 -2
- package/dist/commands/vault.js +41 -8
- package/dist/commands/vault.js.map +1 -1
- package/dist/lib/api-error-handler.d.ts +15 -3
- package/dist/lib/api-error-handler.js +52 -34
- package/dist/lib/api-error-handler.js.map +1 -1
- package/dist/lib/command-aliases.d.ts +8 -0
- package/dist/lib/command-aliases.js +12 -0
- package/dist/lib/command-aliases.js.map +1 -0
- package/dist/lib/constants.d.ts +0 -1
- package/dist/lib/constants.js +0 -1
- package/dist/lib/constants.js.map +1 -1
- package/dist/lib/device-id.d.ts +25 -0
- package/dist/lib/device-id.js +102 -0
- package/dist/lib/device-id.js.map +1 -0
- package/dist/lib/preferences.d.ts +101 -0
- package/dist/lib/preferences.js +198 -0
- package/dist/lib/preferences.js.map +1 -0
- package/dist/lib/run-with-core.js +15 -15
- package/dist/lib/run-with-core.js.map +1 -1
- package/dist/lib/settings.d.ts +6 -0
- package/dist/lib/settings.js +7 -0
- package/dist/lib/settings.js.map +1 -1
- package/dist/lib/telemetry-notice.d.ts +25 -0
- package/dist/lib/telemetry-notice.js +56 -0
- package/dist/lib/telemetry-notice.js.map +1 -0
- package/dist/test/force-insecure-storage.d.ts +1 -0
- package/dist/test/force-insecure-storage.js +9 -0
- package/dist/test/force-insecure-storage.js.map +1 -0
- package/dist/test/setup.d.ts +1 -0
- package/dist/test/setup.js +38 -0
- package/dist/test/setup.js.map +1 -0
- package/dist/utils/analytics.d.ts +41 -0
- package/dist/utils/analytics.js +199 -12
- package/dist/utils/analytics.js.map +1 -1
- package/dist/utils/box.d.ts +29 -1
- package/dist/utils/box.js +92 -4
- package/dist/utils/box.js.map +1 -1
- package/dist/utils/cli-exit.d.ts +15 -0
- package/dist/utils/cli-exit.js +11 -0
- package/dist/utils/cli-exit.js.map +1 -0
- package/dist/utils/cli-symbols.d.ts +1 -1
- package/dist/utils/command-telemetry.d.ts +17 -0
- package/dist/utils/command-telemetry.js +67 -0
- package/dist/utils/command-telemetry.js.map +1 -0
- package/dist/utils/crash-reporter.d.ts +13 -0
- package/dist/utils/crash-reporter.js +91 -0
- package/dist/utils/crash-reporter.js.map +1 -0
- package/dist/utils/debug.d.ts +1 -0
- package/dist/utils/debug.js +4 -1
- package/dist/utils/debug.js.map +1 -1
- package/dist/utils/exit-codes.d.ts +5 -0
- package/dist/utils/exit-codes.js +30 -1
- package/dist/utils/exit-codes.js.map +1 -1
- package/dist/utils/help-json.d.ts +6 -0
- package/dist/utils/help-json.js +87 -10
- package/dist/utils/help-json.js.map +1 -1
- package/dist/utils/output.d.ts +7 -2
- package/dist/utils/output.js +9 -2
- package/dist/utils/output.js.map +1 -1
- package/dist/utils/telemetry-client.d.ts +30 -2
- package/dist/utils/telemetry-client.js +122 -12
- package/dist/utils/telemetry-client.js.map +1 -1
- package/dist/utils/telemetry-store-forward.d.ts +11 -0
- package/dist/utils/telemetry-store-forward.js +94 -0
- package/dist/utils/telemetry-store-forward.js.map +1 -0
- package/dist/utils/telemetry-types.d.ts +58 -9
- package/dist/utils/telemetry-types.js.map +1 -1
- 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> --
|
|
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
|
|
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
|
-
|
|
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
|
-
|
|
748
|
+
Disable with:
|
|
723
749
|
|
|
724
750
|
```bash
|
|
725
|
-
WORKOS_TELEMETRY=false
|
|
751
|
+
WORKOS_TELEMETRY=false workos <command>
|
|
726
752
|
```
|
|
727
753
|
|
|
728
754
|
## Logs
|