@tailor-platform/sdk 0.16.2 → 0.17.0

package/docs/cli/workflow.md

@@ -0,0 +1,144 @@
+# Workflow Commands
+
+Commands for managing workflows and workflow executions.
+
+## workflow
+
+Manage workflows and workflow executions.
+
+```bash
+tailor-sdk workflow <subcommand> [options]
+```
+
+### workflow list
+
+List all workflows in the workspace.
+
+```bash
+tailor-sdk workflow list [options]
+```
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace
+- `-p, --profile` - Workspace profile to use
+- `--json` - Output as JSON
+
+### workflow get
+
+Get workflow details.
+
+```bash
+tailor-sdk workflow get <nameOrId> [options]
+```
+
+**Arguments:**
+
+- `nameOrId` - Workflow name or ID (required)
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace
+- `-p, --profile` - Workspace profile to use
+- `--json` - Output as JSON
+
+### workflow start
+
+Start a workflow execution.
+
+```bash
+tailor-sdk workflow start <nameOrId> [options]
+```
+
+**Arguments:**
+
+- `nameOrId` - Workflow name or ID (required)
+
+**Options:**
+
+- `-m, --machineuser` - Machine user name (required)
+- `-g, --arg` - Workflow argument (JSON string)
+- `-w, --workspace-id` - ID of the workspace
+- `-p, --profile` - Workspace profile to use
+- `-c, --config` - Path to the SDK config file (default: `tailor.config.ts`)
+- `--wait` - Wait for execution to complete
+- `--interval` - Polling interval when using --wait (default: `3s`)
+- `--json` - Output as JSON
+
+**Usage Examples:**
+
+```bash
+# Start a workflow
+tailor-sdk workflow start my-workflow -m admin-machine-user
+
+# Start with argument
+tailor-sdk workflow start my-workflow -m admin -g '{"userId": "123"}'
+
+# Start and wait for completion
+tailor-sdk workflow start my-workflow -m admin --wait
+```
+
+### workflow executions
+
+List or get workflow executions.
+
+```bash
+tailor-sdk workflow executions [executionId] [options]
+```
+
+**Arguments:**
+
+- `executionId` - Execution ID (optional, if provided shows details)
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace
+- `-p, --profile` - Workspace profile to use
+- `-n, --workflow-name` - Filter by workflow name (list mode only)
+- `-s, --status` - Filter by status: `PENDING`, `PENDING_RESUME`, `RUNNING`, `SUCCESS`, `FAILED` (list mode only)
+- `--wait` - Wait for execution to complete (detail mode only)
+- `--interval` - Polling interval when using --wait (default: `3s`)
+- `--logs` - Display job execution logs (detail mode only)
+- `--json` - Output as JSON
+
+**Usage Examples:**
+
+```bash
+# List all executions
+tailor-sdk workflow executions
+
+# Filter by workflow name
+tailor-sdk workflow executions -n my-workflow
+
+# Filter by status
+tailor-sdk workflow executions -s RUNNING
+
+# Get execution details
+tailor-sdk workflow executions <execution-id>
+
+# Get execution details with logs
+tailor-sdk workflow executions <execution-id> --logs
+
+# Wait for execution to complete
+tailor-sdk workflow executions <execution-id> --wait
+```
+
+### workflow resume
+
+Resume a failed or pending workflow execution.
+
+```bash
+tailor-sdk workflow resume <executionId> [options]
+```
+
+**Arguments:**
+
+- `executionId` - Failed or pending execution ID (required)
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace
+- `-p, --profile` - Workspace profile to use
+- `--wait` - Wait for execution to complete after resuming
+- `--interval` - Polling interval when using --wait (default: `3s`)
+- `--json` - Output as JSON

package/docs/cli/workspace.md

@@ -0,0 +1,122 @@
+# Workspace Commands
+
+Commands for managing workspaces and profiles.
+
+## workspace
+
+Manage Tailor Platform workspaces.
+
+```bash
+tailor-sdk workspace <subcommand> [options]
+```
+
+### workspace create
+
+Create a new Tailor Platform workspace.
+
+```bash
+tailor-sdk workspace create [options]
+```
+
+**Options:**
+
+- `-n, --name` - Name of the workspace (required)
+- `-r, --region` - Region of the workspace: `us-west` or `asia-northeast` (required)
+- `-d, --delete-protection` - Enable delete protection for the workspace
+- `-o, --organization-id` - Organization ID to associate the workspace with
+- `-f, --folder-id` - Folder ID to associate the workspace with
+- `--json` - Output as JSON
+
+### workspace list
+
+List all Tailor Platform workspaces.
+
+```bash
+tailor-sdk workspace list [options]
+```
+
+**Options:**
+
+- `--json` - Output as JSON
+- `--limit <number>` - Maximum number of workspaces to list (positive integer)
+
+### workspace delete
+
+Delete a Tailor Platform workspace.
+
+```bash
+tailor-sdk workspace delete [options]
+```
+
+**Options:**
+
+- `-w, --workspace-id` - ID of the workspace to delete (required)
+- `-y, --yes` - Skip confirmation prompt
+
+## profile
+
+Manage workspace profiles (user + workspace combinations).
+
+```bash
+tailor-sdk profile <subcommand> [options]
+```
+
+### profile create
+
+Create a new profile.
+
+```bash
+tailor-sdk profile create <name> [options]
+```
+
+**Arguments:**
+
+- `name` - Profile name (required)
+
+**Options:**
+
+- `-u, --user` - User email (required)
+- `-w, --workspace-id` - Workspace ID (required)
+- `--json` - Output as JSON
+
+### profile list
+
+List all profiles.
+
+```bash
+tailor-sdk profile list [options]
+```
+
+**Options:**
+
+- `--json` - Output as JSON
+
+### profile update
+
+Update profile properties.
+
+```bash
+tailor-sdk profile update <name> [options]
+```
+
+**Arguments:**
+
+- `name` - Profile name (required)
+
+**Options:**
+
+- `-u, --user` - New user email
+- `-w, --workspace-id` - New workspace ID
+- `--json` - Output as JSON
+
+### profile delete
+
+Delete a profile.
+
+```bash
+tailor-sdk profile delete <name>
+```
+
+**Arguments:**
+
+- `name` - Profile name (required)