workos 0.18.0 → 0.19.0

package/dist/utils/help-json.js

@@ -7,6 +7,7 @@
  */
 import { getVersion } from '../lib/settings.js';
 import { COMMAND_ALIASES } from '../lib/command-aliases.js';
+import { MIGRATIONS_DESCRIPTION } from '../lib/constants.js';
 // ---------------------------------------------------------------------------
 // Shared option fragments (mirrors bin.ts shared option objects)
 // ---------------------------------------------------------------------------
@@ -241,6 +242,30 @@ const commands = [
             },
         ],
     },
+    {
+        name: 'verify-login',
+        description: 'Verify the AuthKit login loop end-to-end against the active environment (creates and deletes a throwaway user)',
+        options: [
+            insecureStorageOpt,
+            apiKeyOpt,
+            {
+                name: 'client-id',
+                type: 'string',
+                description: 'WorkOS client ID (overrides the active environment)',
+                required: false,
+                hidden: false,
+            },
+            {
+                name: 'method',
+                type: 'string',
+                description: 'Authentication method to verify',
+                required: false,
+                default: 'password',
+                choices: ['password'],
+                hidden: false,
+            },
+        ],
+    },
     {
         name: 'env',
         description: 'Manage environment configurations (API keys, endpoints, active environment)',
@@ -271,7 +296,7 @@ const commands = [
             },
             {
                 name: 'remove',
-                description: 'Remove an environment configuration',
+                description: 'Remove an environment from local CLI config (does not delete or unclaim the environment in WorkOS)',
                 positionals: [{ name: 'name', type: 'string', description: 'Environment name to remove', required: true }],
             },
             {
@@ -285,7 +310,7 @@ const commands = [
             },
             {
                 name: 'claim',
-                description: 'Claim an unclaimed WorkOS environment (link it to your account)',
+                description: 'Claim an unclaimed WorkOS environment — link it to your account (permanent — cannot be undone)',
                 options: [
                     {
                         name: 'json',
@@ -297,6 +322,20 @@ const commands = [
                     },
                 ],
             },
+            {
+                name: 'provision',
+                description: 'Provision a new unclaimed WorkOS environment (credentials only, no code changes)',
+                options: [
+                    {
+                        name: 'json',
+                        type: 'boolean',
+                        description: 'Output provisioned credentials (apiKey, clientId, claimToken) as JSON',
+                        required: false,
+                        default: false,
+                        hidden: false,
+                    },
+                ],
+            },
         ],
     },
     {
@@ -1215,6 +1254,24 @@ const commands = [
             },
         ],
     },
+    {
+        name: 'setup',
+        description: 'Set up your coding agent (install WorkOS skills + MCP server)',
+        options: [
+            insecureStorageOpt,
+            { name: 'agents', type: 'string', description: 'Comma-separated agent keys', required: false, hidden: false },
+            { name: 'skills-only', type: 'boolean', description: 'Install skills only', required: false, hidden: false },
+            { name: 'mcp-only', type: 'boolean', description: 'Install the MCP server only', required: false, hidden: false },
+            { name: 'yes', type: 'boolean', description: 'Install without prompting', required: false, hidden: false },
+            {
+                name: 'reset',
+                type: 'boolean',
+                description: 'Re-enable automatic setup offers',
+                required: false,
+                hidden: false,
+            },
+        ],
+    },
     {
         name: 'setup-org',
         description: 'One-shot organization onboarding',
@@ -1364,16 +1421,33 @@ const commands = [
                 default: true,
                 hidden: false,
             },
+            {
+                name: 'router',
+                type: 'string',
+                description: 'Next.js router to target when detection is ambiguous (app or pages)',
+                required: false,
+                hidden: false,
+            },
         ],
     },
     {
         name: 'migrations',
-        description: 'Migrate users from identity providers (Auth0, Cognito, Clerk, Firebase) to WorkOS',
+        description: MIGRATIONS_DESCRIPTION,
         options: [insecureStorageOpt, apiKeyOpt],
         commands: [
+            {
+                name: 'export',
+                description: 'Export identity data from a source provider (or any provider via CSV, e.g. Supabase) into a WorkOS migration package',
+            },
+            { name: 'export-template', description: 'Export a blank CSV template with headers and example rows' },
             { name: 'import', description: 'Import users from CSV into WorkOS' },
             { name: 'import-package', description: 'Import a migration package directory' },
+            {
+                name: 'generate-package-template',
+                description: 'Generate an empty migration package skeleton for manual or scripted population',
+            },
             { name: 'validate', description: 'Validate a WorkOS migration CSV file' },
+            { name: 'validate-package', description: 'Validate a migration package directory against the schema contract' },
             { name: 'export-auth0', description: 'Export users from Auth0' },
             { name: 'export-cognito', description: 'Export users from AWS Cognito' },
             { name: 'merge-passwords', description: 'Merge Auth0 password exports into CSV' },
@@ -1381,10 +1455,47 @@ const commands = [
             { name: 'transform-firebase', description: 'Transform Firebase JSON to WorkOS format' },
             { name: 'analyze', description: 'Analyze import errors and generate retry plan' },
             { name: 'enroll-totp', description: 'Enroll TOTP MFA factors' },
-            { name: 'process-role-definitions', description: 'Create roles and assign in WorkOS' },
+            { name: 'process-roles', description: 'Create roles and assign permissions in WorkOS' },
             { name: 'wizard', description: 'Guided interactive migration wizard' },
         ],
     },
+    {
+        name: 'emulate',
+        description: 'Start a local WorkOS API emulator',
+        options: [
+            {
+                name: 'port',
+                type: 'number',
+                description: 'Port to listen on',
+                required: false,
+                default: 4100,
+                alias: 'p',
+                hidden: false,
+            },
+            {
+                name: 'seed',
+                type: 'string',
+                description: 'Path to seed config file (YAML or JSON)',
+                required: false,
+                alias: 's',
+                hidden: false,
+            },
+            {
+                name: 'interactive',
+                type: 'boolean',
+                description: 'Show login pages for SSO/AuthKit',
+                required: false,
+                default: false,
+                alias: 'i',
+                hidden: false,
+            },
+        ],
+        examples: [
+            'workos emulate',
+            'workos emulate --port 9100 --json',
+            'workos emulate --seed workos-emulate.config.yaml',
+        ],
+    },
 ];
 const globalOptions = [
     {