Merge branch 'master' into chris-update-links

Author: christopher-hakkaart

platform-cli-docs/docs/reference/actions.md

@@ -24,7 +24,7 @@ tw actions list [OPTIONS]
 
 | Option | Description | Required | Default |
 |--------|-------------|----------|----------|
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -42,7 +42,7 @@ Example output:
 
 ID                     | Name  | Endpoint                                                                                      | Status | Source
     ------------------------+-------+-----------------------------------------------------------------------------------------------+--------+--------
-     1a2b3c4d5e6f7g8h9i0j1k | Testy | https://api.cloud.seqera.io/actions/1a2b3c4d5e6f7g8h9i0j1k/launch?workspaceId=123456789012345 | ACTIVE | tower
+     2b3c4d5e6f7g8h | Testy | https://api.cloud.seqera.io/actions/2b3c4d5e6f7g8h/launch?workspaceId=123456789012345 | ACTIVE | tower
 ```
 
 ## tw actions view
@@ -59,7 +59,7 @@ tw actions view [OPTIONS]
 |--------|-------------|----------|----------|
 | `-i`, `--id` | Action unique identifier | No | `null` |
 | `-n`, `--name` | Action name | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -76,12 +76,12 @@ Details for action 'Testy'
 
 
 --------------+-------------------------------------------------------------------
-     ID           | 1a2b3c4d5e6f7g8h9i0j1k
+     ID           | 2b3c4d5e6f7g8h
      Name         | Testy
      Status       | ACTIVE
      Pipeline URL | https://github.com/nextflow-io/rnaseq-nf
      Source       | tower
-     Hook URL     | https://api.cloud.seqera.io/actions/1a2b3c4d5e6f7g8h9i0j1k/launch
+     Hook URL     | https://api.cloud.seqera.io/actions/2b3c4d5e6f7g8h/launch
      Last event   | never
      Date created | Tue, 10 Jun 2025 09:02:12 GMT
      Last event   | never
@@ -116,13 +116,20 @@ Run `tw actions add -h` to view the list of supported event sources.
 
 Run `tw actions add <source> -h` to view the required and optional fields for your event source.
 
+:::note
+Supported event sources:
+- **tower**: Manual webhook trigger via Platform UI or API
+- **github**: GitHub webhook events (push, pull request, etc.)
+:::
+
 ### Options
 
 | Option | Description | Required | Default |
 |--------|-------------|----------|----------|
 | `-n`, `--name` | Action name. Must be unique per workspace. Names consist of alphanumeric, hyphen, and underscore characters. | Yes | `null` |
+| `--pipeline` | Pipeline repository URL. Must be a full Git repository URL (e.g., https://github.com/nextflow-io/hello). | Yes | `null` |
 | `-i`, `--id` | Action unique identifier | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format. Required if `TOWER_WORKSPACE_ID` environment variable is not set. | Yes* | `TOWER_WORKSPACE_ID` |
 | `-c`, `--compute-env` | Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted. Provide the name or identifier. | No | `null` |
 | `--work-dir` | Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted. | No | `null` |
 | `-p`, `--profile` | Array of Nextflow configuration profile names to apply. | No | `null` |
@@ -173,7 +180,7 @@ tw actions update [OPTIONS]
 | `--new-name` | Updated action name. Must be unique per workspace. Names consist of alphanumeric, hyphen, and underscore characters. | No | `null` |
 | `-i`, `--id` | Action unique identifier | No | `null` |
 | `-n`, `--name` | Action name | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 | `-c`, `--compute-env` | Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted. Provide the name or identifier. | No | `null` |
 | `--work-dir` | Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted. | No | `null` |
 | `-p`, `--profile` | Array of Nextflow configuration profile names to apply. | No | `null` |
@@ -218,7 +225,7 @@ tw actions delete [OPTIONS]
 |--------|-------------|----------|----------|
 | `-i`, `--id` | Action unique identifier | No | `null` |
 | `-n`, `--name` | Action name | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -248,6 +255,7 @@ tw actions labels [OPTIONS]
 |--------|-------------|----------|----------|
 | `-i`, `--id` | Action unique identifier | No | `null` |
 | `-n`, `--name` | Action name | No | `null` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | Personal workspace |
 | `--no-create` | Assign labels without creating the ones which were not found. | No | `null` |
 | `--operations`, `-o` | Type of operation (set, append, delete) [default: set]. | No | `set` |
 
@@ -262,7 +270,7 @@ tw actions labels -n Testy -w 123456789012345 test-environment,label2
 Example output:
 
 ```bash
-'set' labels on 'action' with id '1a2b3c4d5e6f7g8h9i0j1k' at 123456789012345 workspace
+'set' labels on 'action' with id '2b3c4d5e6f7g8h' at 123456789012345 workspace
 ```
 
 :::note

platform-cli-docs/docs/reference/collaborators.md

@@ -38,13 +38,13 @@ tw collaborators list -o seqeralabs
 Example output:
 
 ```bash
-Collaborators for 88848180287xxx organization:
+Collaborators for 888481802873456 organization:
 
 ID              | Username             | Email
   -----------------+----------------------+--------------------
-    13136942731xxx  | external_user1       | user1@domain.com
-    127726720173xxx | external_user2       | user2@domain.com
-    59151157784xxx  | external_user3       | user3@domain.com
-    132868466675xxx | external_user4       | user4@domain.com
-    178756942629xxx | external_user5       | user5@domain.com
+    131369427314567  | external_user1       | user1@domain.com
+    127726720173456 | external_user2       | user2@domain.com
+    591511577845678  | external_user3       | user3@domain.com
+    132868466675789 | external_user4       | user4@domain.com
+    178756942629012 | external_user5       | user5@domain.com
 ```

platform-cli-docs/docs/reference/compute-envs.md

@@ -67,7 +67,7 @@ tw compute-envs update [OPTIONS]
 | `--new-name` | New compute environment name. | No | `null` |
 | `-i`, `--id` | Compute environment unique identifier. | No | `null` |
 | `-n`, `--name` | Compute environment name. | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -97,7 +97,7 @@ tw compute-envs delete [OPTIONS]
 |--------|-------------|----------|---------|
 | `-i`, `--id` | Compute environment unique identifier. | No | `null` |
 | `-n`, `--name` | Compute environment name. | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -127,7 +127,7 @@ tw compute-envs view [OPTIONS]
 |--------|-------------|----------|---------|
 | `-i`, `--id` | Compute environment unique identifier. | No | `null` |
 | `-n`, `--name` | Compute environment name. | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -194,7 +194,7 @@ tw compute-envs list [OPTIONS]
 
 | Option | Description | Required | Default |
 |--------|-------------|----------|---------|
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -235,7 +235,7 @@ tw compute-envs export [OPTIONS]
 |--------|-------------|----------|---------|
 | `-i`, `--id` | Compute environment unique identifier. | No | `null` |
 | `-n`, `--name` | Compute environment name. | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -256,14 +256,18 @@ Example output:
 Import a compute environment configuration from a JSON file.
 
 ```bash
-tw compute-envs import [OPTIONS]
+tw compute-envs import [OPTIONS] <path/to/json-file>
 ```
 
 ### Options
 
 | Option | Description | Required | Default |
 |--------|-------------|----------|---------|
+| `-n`, `--name` | Name for the imported compute environment. | Yes | `null` |
+| `-c`, `--credentials` | Credentials identifier to use when multiple credentials match the compute environment. Use this to specify which credentials should be associated with the imported compute environment. | No | `null` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 | `--overwrite` | Overwrite the compute environment if it already exists. | No | `false` |
+| `<path/to/json-file>` | Path to the JSON file containing the compute environment configuration (exported using `tw compute-envs export`). | Yes | `null` |
 
 ### Example
 
@@ -279,6 +283,10 @@ Example output:
 New AWS-CLOUD compute environment 'example-imported-ce' added at [my-organization / my-workspace] workspace
 ```
 
+:::note
+If multiple credentials match the imported compute environment, you must provide the `-c` flag with the credentials identifier to specify which credentials to use. You can find available credentials using `tw credentials list`.
+:::
+
 ## tw compute-envs primary
 
 Manage the primary compute environment.
@@ -299,7 +307,7 @@ tw compute-envs primary get [OPTIONS]
 
 | Option | Description | Required | Default |
 |--------|-------------|----------|---------|
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -329,7 +337,7 @@ tw compute-envs primary set [OPTIONS]
 |--------|-------------|----------|---------|
 | `-i`, `--id` | Compute environment unique identifier. | No | `null` |
 | `-n`, `--name` | Compute environment name. | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 

platform-cli-docs/docs/reference/credentials.md

@@ -17,15 +17,22 @@ To launch pipelines in a Platform workspace, you need [credentials](https://docs
 Add workspace credentials.
 
 ```bash
-tw credentials add [OPTIONS]
+tw credentials add <provider> [OPTIONS]
 ```
 
 Run `tw credentials add -h` to view a list of providers.
 
 Run `tw credentials add <provider> -h` to view the required fields for your provider.
 
+### Common Options
+
+| Option | Description | Required | Default |
+|--------|-------------|----------|---------|
+| `-n`, `--name` | Credentials name. Must be unique per workspace. | Yes | `null` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | Personal workspace |
+
 :::note
-You can add multiple credentials from the same provider in the same workspace.
+Additional provider-specific options are required depending on the provider type. Use `tw credentials add <provider> -h` to see all available options for your provider. You can add multiple credentials from the same provider in the same workspace.
 :::
 
 ### Compute environment credentials
@@ -35,7 +42,7 @@ Platform requires credentials to access your cloud compute environments. See the
 Command:
 
 ```bash
-tw credentials add aws --name=my_aws_creds --access-key=<aws access key> --secret-key=<aws secret key>
+tw credentials add aws --name=my_aws_creds --access-key=AKIAIOSFODNN7EXAMPLE --secret-key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
 ```
 
 Example output:
@@ -51,7 +58,7 @@ Platform requires access credentials to interact with pipeline Git repositories.
 Command:
 
 ```bash
-tw credentials add github -n=my_GH_creds -u=<GitHub username> -p=<GitHub access token>
+tw credentials add github -n=my_GH_creds -u=my-github-user -p=ghp_exampletoken1234567890abcdefghij
 ```
 
 Example output:
@@ -71,7 +78,7 @@ Container registry credentials are only used by the Wave container service. See
 Command:
 
 ```bash
-tw credentials add container-reg --name=my_registry_creds --username=<registry username> --password=<registry password> --registry=docker.io
+tw credentials add container-reg --name=my_registry_creds --username=my-registry-user --password=my-secure-password-123 --registry=docker.io
 ```
 
 Example output:
@@ -85,13 +92,25 @@ New CONTAINER-REG credentials 'my_registry_creds (2tyCywygy9yoyeyHyRyryI)' added
 Update workspace credentials.
 
 ```bash
-tw credentials update [OPTIONS]
+tw credentials update <provider> [OPTIONS]
 ```
 
 Run `tw credentials update -h` to view a list of providers.
 
 Run `tw credentials update <provider> -h` to view the required fields for your provider.
 
+### Common Options
+
+| Option | Description | Required | Default |
+|--------|-------------|----------|---------|
+| `-i`, `--id` | Credentials unique identifier | No | `null` |
+| `-n`, `--name` | Credentials name | No | `null` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | Personal workspace |
+
+:::note
+Additional provider-specific options vary depending on the provider type. Use `tw credentials update <provider> -h` to see all available options for your provider. Either credentials ID (`-i`) or name (`-n`) is required to identify which credentials to update.
+:::
+
 ### Example
 
 Command:
@@ -120,7 +139,7 @@ tw credentials delete [OPTIONS]
 |--------|-------------|----------|---------|
 | `-i`, `--id` | Credentials unique identifier | No | `null` |
 | `-n`, `--name` | Credentials name | No | `null` |
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example
 
@@ -148,7 +167,7 @@ tw credentials list [OPTIONS]
 
 | Option | Description | Required | Default |
 |--------|-------------|----------|---------|
-| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` |
+| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable, or personal workspace if not set) | No | `TOWER_WORKSPACE_ID` |
 
 ### Example