diff --git a/platform-cli-docs/docs/reference/actions.md b/platform-cli-docs/docs/reference/actions.md index 218744262..7133cee00 100644 --- a/platform-cli-docs/docs/reference/actions.md +++ b/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 -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 diff --git a/platform-cli-docs/docs/reference/collaborators.md b/platform-cli-docs/docs/reference/collaborators.md index 496944d29..bb945475e 100644 --- a/platform-cli-docs/docs/reference/collaborators.md +++ b/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 ``` diff --git a/platform-cli-docs/docs/reference/compute-envs.md b/platform-cli-docs/docs/reference/compute-envs.md index 9094cb654..9fe306f60 100644 --- a/platform-cli-docs/docs/reference/compute-envs.md +++ b/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] ``` ### 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 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 diff --git a/platform-cli-docs/docs/reference/credentials.md b/platform-cli-docs/docs/reference/credentials.md index 1ea3e0303..6407687d8 100644 --- a/platform-cli-docs/docs/reference/credentials.md +++ b/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 [OPTIONS] ``` Run `tw credentials add -h` to view a list of providers. Run `tw credentials add -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 -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= --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= -p= +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= --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 [OPTIONS] ``` Run `tw credentials update -h` to view a list of providers. Run `tw credentials update -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 -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 diff --git a/platform-cli-docs/docs/reference/data-links.md b/platform-cli-docs/docs/reference/data-links.md index f7ab655bf..7ff6c1c64 100644 --- a/platform-cli-docs/docs/reference/data-links.md +++ b/platform-cli-docs/docs/reference/data-links.md @@ -31,7 +31,7 @@ tw data-links list [OPTIONS] | `--wait` | Wait for all data links to be fetched to cache | No | `null` | | `-n`, `--name` | Filter by data-link name | No | `null` | | `--visibility` | Filter by visibility: hidden, visible, or all | 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` | | `--page` | Page number for paginated results (default: 1) | No | `null` | | `--offset` | Row offset for paginated results (default: 0) | No | `null` | | `--max` | Maximum number of records to display (default: ) | No | `null` | @@ -111,7 +111,7 @@ tw data-links add [OPTIONS] | `-u`, `--uri` | Data link URI | Yes | `null` | | `-p`, `--provider` | Cloud provider: aws, azure, or google | Yes | `null` | | `-c`, `--credentials` | Credentials identifier. **Required for private cloud storage buckets** | 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` | Run `tw data-links add -h` to view all the required and optional fields for adding a custom data-link to a workspace. @@ -146,7 +146,7 @@ tw data-links delete [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` | | `-i`, `--id` | Data link identifier | No | `null` | | `-n`, `--name` | Data link name | No | `null` | | `--uri` | Data link URI (e.g., s3://bucket-name) | No | `null` | @@ -185,7 +185,7 @@ tw data-links update [OPTIONS] | `-n`, `--name` | Data link name | Yes | `null` | | `-d`, `--description` | Data link description | No | `null` | | `-c`, `--credentials` | Credentials identifier. **Required for private cloud storage buckets** | 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` | Run `tw data-links update -h` to view all the required and optional fields for updating a custom data-link in a workspace. Users with the `MAINTAIN` role and above for a workspace can update custom data-links. @@ -224,7 +224,7 @@ tw data-links browse [OPTIONS] | `-f`, `--filter` | Filter results by prefix | No | `null` | | `-t`, `--token` | Next page token for pagination | No | `null` | | `--page` | Page number to display | 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` | | `-i`, `--id` | Data link identifier | No | `null` | | `-n`, `--name` | Data link name | No | `null` | | `--uri` | Data link URI (e.g., s3://bucket-name) | No | `null` | @@ -295,7 +295,7 @@ tw data-links download [OPTIONS] |--------|-------------|----------|----------| | `-c`, `--credentials` | Credentials identifier. **Required for private cloud storage buckets** | Yes | `null` | | `-o`, `--output-dir` | Output directory for downloaded files | 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` | | `-i`, `--id` | Data link identifier | No | `null` | | `-n`, `--name` | Data link name | No | `null` | | `--uri` | Data link URI (e.g., s3://bucket-name) | No | `null` | @@ -307,7 +307,7 @@ Run `tw data-links download -h` to view all the required and optional fields for Command: ```bash -tw data-links download -n my-bucket -c -w path/to/file.txt +tw data-links download -n my-bucket -c 1sxCxvxfx8xnxdxGxQxqxH -w 123456789012345 path/to/file.txt ``` Example output: @@ -331,7 +331,7 @@ Successfully downloaded files Command: ```bash -tw data-links download -n my-bucket -c -w path/to/my-directory/ +tw data-links download -n my-bucket -c 1sxCxvxfx8xnxdxGxQxqxH -w 123456789012345 path/to/my-directory/ ``` Example output: @@ -364,7 +364,7 @@ tw data-links upload [OPTIONS] |--------|-------------|----------|----------| | `-c`, `--credentials` | Credentials identifier. **Required for private cloud storage buckets** | Yes | `null` | | `-o`, `--output-dir` | Destination directory in the data link | 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` | | `-i`, `--id` | Data link identifier | No | `null` | | `-n`, `--name` | Data link name | No | `null` | | `--uri` | Data link URI (e.g., s3://bucket-name) | No | `null` | @@ -376,7 +376,7 @@ Run `tw data-links upload -h` to view all the required and optional fields for u Command: ```bash -tw data-links upload -n my-bucket -c -w path/to/file.txt +tw data-links upload -n my-bucket -c 1sxCxvxfx8xnxdxGxQxqxH -w 123456789012345 path/to/file.txt ``` Example output: @@ -403,7 +403,7 @@ Successfully uploaded files Command: ```bash -tw data-links upload -n my-bucket -c -w path/to/my-directory/ +tw data-links upload -n my-bucket -c 1sxCxvxfx8xnxdxGxQxqxH -w 123456789012345 path/to/my-directory/ ``` Example output: diff --git a/platform-cli-docs/docs/reference/datasets.md b/platform-cli-docs/docs/reference/datasets.md index e1bc848c7..de1305ec2 100644 --- a/platform-cli-docs/docs/reference/datasets.md +++ b/platform-cli-docs/docs/reference/datasets.md @@ -25,7 +25,7 @@ tw datasets add [OPTIONS] | `-d`, `--description` | Optional dataset description. | No | `null` | | `--header` | Treat first row as header | No | `null` | | `--overwrite` | Overwrite the dataset if it already exists | No | `false` | -| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | Yes | `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) | Yes | `TOWER_WORKSPACE_ID` | Run `tw datasets add -h` to view the required and optional fields for adding a dataset. @@ -36,13 +36,13 @@ Add a preconfigured dataset file to a workspace (include the `--header` flag if Command: ```bash -tw datasets add --name=samplesheet1 --header samplesheet_test.csv +tw datasets add --name=samplesheet1 --header samplesheet_test.csv -w 123456789012345 ``` Example output: ```bash -Dataset 'samplesheet1' added at user workspace with id '60gGrD4I2Gk0TUpEGOj5Td' +Dataset 'samplesheet1' added at [my-organization / my-workspace] workspace with id '60gGrD4I2Gk0TUpEGOj5Td' ``` :::note @@ -63,7 +63,7 @@ tw datasets delete [OPTIONS] |--------|-------------|----------|----------| | `-i`, `--id` | Dataset unique identifier | No | `null` | | `-n`, `--name` | Dataset name | No | `null` | -| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | Yes | `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) | Yes | `TOWER_WORKSPACE_ID` | To delete a workspace dataset, specify either the dataset name (`-n` flag) or ID (`-i` flag). @@ -96,7 +96,7 @@ tw datasets download [OPTIONS] | `--dataset-version` | Dataset version to download | No | `null` | | `-i`, `--id` | Dataset unique identifier | No | `null` | | `-n`, `--name` | Dataset name | No | `null` | -| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | Yes | `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) | Yes | `TOWER_WORKSPACE_ID` | View a stored dataset's contents. @@ -134,7 +134,7 @@ tw datasets list [OPTIONS] | Option | Description | Required | Default | |--------|-------------|----------|----------| | `-f`, `--filter` | Filter datasets by name substring | No | `null` | -| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | Yes | `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) | Yes | `TOWER_WORKSPACE_ID` | Run `tw datasets list -h` to view the optional fields for listing and filtering datasets. @@ -170,7 +170,7 @@ tw datasets view [OPTIONS] |--------|-------------|----------|----------| | `-i`, `--id` | Dataset unique identifier | No | `null` | | `-n`, `--name` | Dataset name | No | `null` | -| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | Yes | `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) | Yes | `TOWER_WORKSPACE_ID` | Run `tw datasets view -h` to view the required and optional fields for viewing a stored dataset's details. @@ -205,6 +205,38 @@ Display dataset versions. tw datasets view versions [OPTIONS] ``` +### Options + +| Option | Description | Required | Default | +|--------|-------------|----------|---------| +| `-i`, `--id` | Dataset identifier | No | `null` | +| `-n`, `--name` | Dataset 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 +Either dataset ID (`-i`) or name (`-n`) is required to identify which dataset to view versions for. +::: + +### Example + +Command: + +```bash +tw datasets view versions -n my-reference-data -w 123456789012345 +``` + +Example output: + +```bash +Versions for dataset 'my-reference-data' at [my-organization / my-workspace] workspace: + +Version | Created | Size +--------|--------------------------------|-------- +v1.0 | Mon, 19 Aug 2024 07:59:16 GMT | 1.2 MB +v1.1 | Tue, 20 Aug 2024 10:15:23 GMT | 1.3 MB +v2.0 | Wed, 21 Aug 2024 14:30:45 GMT | 2.1 MB +``` + ## tw datasets update Update a dataset. @@ -223,7 +255,7 @@ tw datasets update [OPTIONS] | `-f`, `--file` | Data file to upload | No | `null` | | `-i`, `--id` | Dataset unique identifier | No | `null` | | `-n`, `--name` | Dataset name | No | `null` | -| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | Yes | `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) | Yes | `TOWER_WORKSPACE_ID` | Run `tw datasets update -h` to view the required and optional fields for updating a dataset. @@ -256,7 +288,7 @@ tw datasets url [OPTIONS] | `--dataset-version` | Dataset version for URL | No | `null` | | `-i`, `--id` | Dataset unique identifier | No | `null` | | `-n`, `--name` | Dataset name | No | `null` | -| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | Yes | `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) | Yes | `TOWER_WORKSPACE_ID` | ### Example diff --git a/platform-cli-docs/docs/reference/labels.md b/platform-cli-docs/docs/reference/labels.md index 9bbd4be51..382c12e91 100644 --- a/platform-cli-docs/docs/reference/labels.md +++ b/platform-cli-docs/docs/reference/labels.md @@ -23,7 +23,7 @@ tw labels add [OPTIONS] |--------|-------------|----------|----------| | `-n`, `--name` | Label name | Yes | `null` | | `-v`, `--value` | Label value | 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` | Run `tw labels add -h` to view the required and optional fields for adding a label. @@ -32,20 +32,40 @@ Run `tw labels add -h` to view the required and optional fields for adding a lab [Labels](https://docs.seqera.io/platform-cloud/labels/overview) require only a name and can be applied to pipelines, runs, and actions. ::: -### Example +### Examples + +**Example 1: Add a resource label (with value)** Command: ```bash -tw labels add -n Label1 -w DocTestOrg2/Testing -v Value1 +tw labels add -n environment -v production -w 123456789012345 ``` Example output: ```bash -Label 'Label1=Value1' added at 'DocTestOrg2/Testing' workspace with id '268741348267491' +Label 'environment=production' added at [my-organization / my-workspace] workspace with id '268741348267491' +``` + +**Example 2: Add a regular label (name only)** + +Command: + +```bash +tw labels add -n high-priority -w 123456789012345 ``` +Example output: + +```bash +Label 'high-priority' added at [my-organization / my-workspace] workspace with id '268741348267492' +``` + +:::tip +Resource labels (with values) are useful for cost tracking and filtering cloud resources. Regular labels are useful for categorizing and organizing pipelines, runs, and actions within Platform. +::: + ## tw labels list List labels. @@ -60,7 +80,7 @@ tw labels list [OPTIONS] |--------|-------------|----------|----------| | `-t`, `--type` | Label type: normal, resource, or all (default: all) | No | `all` | | `-f`, `--filter` | Filter labels by substring | 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` | | `--page` | Page number for paginated results (default: 1) | No | `null` | | `--offset` | Row offset for paginated results (default: 0) | No | `null` | | `--max` | Maximum number of records to display (default: ) | No | `null` | @@ -105,7 +125,7 @@ tw labels update [OPTIONS] | `-i`, `--id` | Label identifier | Yes | `null` | | `-n`, `--name` | Label name | No | `null` | | `-v`, `--value` | Label value | 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` | Run `tw labels update -h` to view the required and optional fields for updating labels. @@ -136,7 +156,7 @@ tw labels delete [OPTIONS] | Option | Description | Required | Default | |--------|-------------|----------|----------| | `-i`, `--id` | Label ID | Yes | `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` | Run `tw labels delete -h` to view the required and optional fields for deleting labels. diff --git a/platform-cli-docs/docs/reference/launch.md b/platform-cli-docs/docs/reference/launch.md index 65016660c..7591dca5a 100644 --- a/platform-cli-docs/docs/reference/launch.md +++ b/platform-cli-docs/docs/reference/launch.md @@ -8,11 +8,17 @@ description: Launch a pipeline Launch a pipeline. ```bash -tw launch [OPTIONS] +tw launch [OPTIONS] ``` Run `tw launch -h` to view supported launch options. +The `` parameter can be: +- **Saved pipeline name**: Launch a pre-configured pipeline from your workspace Launchpad (e.g., `nf-hello-2026`) +- **Git repository URL**: Launch directly from a pipeline repository (e.g., `https://github.com/nextflow-io/hello`) + +Use saved pipeline names for pre-configured workflows with specific parameters and compute environments. Use Git URLs for ad-hoc pipeline execution or when launching pipelines not yet saved to the workspace. + ## Options | Option | Description | Required | Default | @@ -39,7 +45,7 @@ Run `tw launch -h` to view supported launch options. | `--disable-optimization` | Turn off the optimization for the pipeline before launching. | No | `null` | | `--head-job-cpus` | Number of CPUs allocated for the Nextflow head job. | No | `null` | | `--head-job-memory` | Memory allocation for the Nextflow head job in megabytes. | 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 diff --git a/platform-cli-docs/docs/reference/participants.md b/platform-cli-docs/docs/reference/participants.md index 639ae10bb..6d654e5d5 100644 --- a/platform-cli-docs/docs/reference/participants.md +++ b/platform-cli-docs/docs/reference/participants.md @@ -70,7 +70,7 @@ tw participants add [OPTIONS] Run `tw participants add -h` to view the required and optional fields for adding a participant. -To add a new _collaborator_ to the workspace, use the `add` subcommand. The default role assigned to a _collaborator_ is `Launch`. +To add a new participant to the workspace, use the `add` subcommand. When adding a COLLABORATOR type participant, the default role assigned is `Launch`. For MEMBER type participants, you can specify organization members who will have access to the workspace. See [Participant roles](https://docs.seqera.io/platform-cloud/orgs-and-teams/roles) for more information. @@ -79,13 +79,13 @@ See [Participant roles](https://docs.seqera.io/platform-cloud/orgs-and-teams/rol Command: ```bash -tw participants add --name=collaborator@mydomain.com --type=MEMBER +tw participants add --name=collaborator@mydomain.com --type=COLLABORATOR -w 123456789012345 ``` Example output: ```bash -User 'collaborator' was added as participant to 'shared-workspace' workspace with role 'launch' +User 'collaborator@mydomain.com' was added as participant to [my-organization / my-workspace] workspace with role 'launch' ``` ## tw participants update diff --git a/platform-cli-docs/docs/reference/pipelines.md b/platform-cli-docs/docs/reference/pipelines.md index 32bb7d51f..8ad87e92f 100644 --- a/platform-cli-docs/docs/reference/pipelines.md +++ b/platform-cli-docs/docs/reference/pipelines.md @@ -57,7 +57,7 @@ ID | Name | Repository | Add a pipeline. ```bash -tw pipelines add [OPTIONS] +tw pipelines add [OPTIONS] ``` ### Options @@ -65,6 +65,7 @@ tw pipelines add [OPTIONS] | Option | Description | Required | Default | |--------|-------------|----------|----------| | `-n`, `--name` | Pipeline name. Must be unique within the workspace. | Yes | `null` | +| `` | Pipeline repository URL. Must be a full Git repository URL (e.g., https://github.com/nextflow-io/rnaseq-nf). | Yes | `null` | | `-d`, `--description` | Pipeline description. | No | `null` | | `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` | | `--labels` | Labels to apply to the resource. Provide comma-separated label values (use key=value format for resource labels). Labels will be created if they don't exist | No | `null` | @@ -96,13 +97,14 @@ Command: tw pipelines add --name=my_rnaseq_nf_pipeline \ --params-file=my_rnaseq_nf_pipeline_params.yaml \ --config= \ +-w 123456789012345 \ https://github.com/nextflow-io/rnaseq-nf ``` Example output: ```bash -New pipeline 'my_rnaseq_nf_pipeline' added at user workspace +New pipeline 'my_rnaseq_nf_pipeline' added at [my-organization / my-workspace] workspace ``` The optional `--params-file` flag is used to pass a set of default parameters that will be associated with the pipeline in the Launchpad. diff --git a/platform-cli-docs/docs/reference/runs.md b/platform-cli-docs/docs/reference/runs.md index 7f8ee6b65..183071ab1 100644 --- a/platform-cli-docs/docs/reference/runs.md +++ b/platform-cli-docs/docs/reference/runs.md @@ -99,18 +99,44 @@ tw runs view download [OPTIONS] Display pipeline run metrics. ```bash -tw runs view metrics [OPTIONS] +tw runs view -i [OPTIONS] metrics ``` +This subcommand displays resource usage metrics for pipeline runs. You must specify the run ID using the `-i` flag from the parent `tw runs view` command. + ### Options | Option | Description | Required | Default | |--------|-------------|----------|----------| +| `-i`, `--id` | Pipeline run identifier (from parent command). | 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 | | `-f`, `--filter` | Filter metrics by process name. Shows statistics only for processes matching the specified name. | No | `null` | | `-t`, `--type` | Metric types to display: cpu, mem, time, io. Comma-separated list. Default: all types. | No | `null` | | `-c`, `--columns` | Statistical columns to display: min, q1, q2, q3, max, mean. Shows quartile distribution of resource usage. Default: all columns. | No | `null` | | `-v`, `--view` | Table view format. Options: condensed (compact), extended (detailed). Default: condensed. | No | `null` | +### Example + +Command: + +```bash +tw runs view -i 2vFUbBx63cfsBY --workspace 123456789012345 metrics +``` + +Example output: + +```bash +Run metrics at [my-organization / my-workspace] workspace: + +Process metrics for run '2vFUbBx63cfsBY': + +Process Name | CPU (mean) | Memory (mean) | Time (mean) | Status +----------------|------------|---------------|-------------|-------- +NFCORE_RNASEQ | 95.2% | 4.2 GB | 2h 15m | COMPLETED +FASTQC | 82.1% | 2.1 GB | 45m | COMPLETED +STAR_ALIGN | 98.5% | 32.5 GB | 1h 30m | COMPLETED +``` + ### tw runs view tasks Display pipeline run tasks. diff --git a/platform-cli-docs/docs/reference/secrets.md b/platform-cli-docs/docs/reference/secrets.md index c9903e6f9..cef97d8fc 100644 --- a/platform-cli-docs/docs/reference/secrets.md +++ b/platform-cli-docs/docs/reference/secrets.md @@ -21,7 +21,7 @@ tw secrets 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 @@ -57,7 +57,7 @@ tw secrets add [OPTIONS] | `-n`, `--name` | Secret name. Must be unique per workspace. Names consist of alphanumeric, hyphen, and underscore characters. | Yes | `null` | | `-v`, `--value` | Secret value, to be stored securely. The secret is made available to pipeline executions at runtime. | No | `null` | | `--overwrite` | Overwrite the secret if it already exists | No | `false` | -| `-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` | Run `tw secrets add -h` to view the required and optional fields for adding a secret. @@ -87,7 +87,7 @@ tw secrets view [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` | | `-i`, `--id` | Secret identifier | No | `null` | | `-n`, `--name` | Secret name | No | `null` | @@ -126,7 +126,7 @@ tw secrets update [OPTIONS] | Option | Description | Required | Default | |--------|-------------|----------|----------| | `-v`, `--value` | New secret value, to be stored securely. The secret is made available to pipeline executions at runtime. | 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` | | `-i`, `--id` | Secret identifier | No | `null` | | `-n`, `--name` | Secret name | No | `null` | @@ -156,7 +156,7 @@ tw secrets delete [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` | | `-i`, `--id` | Secret identifier | No | `null` | | `-n`, `--name` | Secret name | No | `null` | diff --git a/platform-cli-docs/docs/reference/studios.md b/platform-cli-docs/docs/reference/studios.md index b706f6e25..30d90b224 100644 --- a/platform-cli-docs/docs/reference/studios.md +++ b/platform-cli-docs/docs/reference/studios.md @@ -25,7 +25,7 @@ tw studios view [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). Studios are not available in personal workspaces. | No | `TOWER_WORKSPACE_ID` | | `-i`, `--id` | Studio session identifier | No | `null` | | `-n`, `--name` | Studio name | No | `null` | @@ -76,21 +76,21 @@ tw studios list [OPTIONS] | Option | Description | Required | Default | |--------|-------------|----------|----------| | `-f`, `--filter` | Optional filter criteria, allowing free text search on name and templateUrl and keywords: `userName`, `computeEnvName` and `status`. Example keyword usage: -f status:RUNNING. | 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). Studios are not available in personal workspaces. | No | `TOWER_WORKSPACE_ID` | | `--page` | Page number for paginated results (default: 1) | No | `null` | | `--offset` | Row offset for paginated results (default: 0) | No | `null` | | `--max` | Maximum number of records to display (default: ) | No | `null` | -Run `tw studios checkpoints -h` to view the required and optional fields for viewing checkpoints for a session. +Run `tw studios list -h` to view the required and optional fields for listing studios. -List all checkpoints for an existing Studio session in a workspace. See [Session checkpoints](https://docs.seqera.io/platform-cloud/studios/managing#studio-session-checkpoints) for more information. +List all studios in a workspace. ### Example Command: ```bash -tw studios checkpoints -i 9s0t1u2v -w 222333444555666 +tw studios list -w 123456789012345 ``` Example output: @@ -117,7 +117,8 @@ tw studios templates [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` | +| `--max` | Maximum number of templates to return. | No | `20` | +| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable). Studios are not available in personal workspaces. | No | `TOWER_WORKSPACE_ID` | ### Example @@ -157,7 +158,7 @@ tw studios start [OPTIONS] | `--wait` | Wait until given status or fail. Valid options: STARTING, RUNNING, STOPPED, STOPPING. | No | `null` | | `--labels` | Comma-separated list of labels | No | `null` | | `--description` | Optional configuration override for 'description'. | 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). Studios are not available in personal workspaces. | No | `TOWER_WORKSPACE_ID` | | `-i`, `--id` | Studio session identifier | No | `null` | | `-n`, `--name` | Studio name | No | `null` | | `--gpu` | Optional configuration override for 'gpu' setting (integer representing number of cores). | No | `null` | @@ -165,7 +166,7 @@ tw studios start [OPTIONS] | `--memory` | Optional configuration override for 'memory' setting (integer representing memory in MBs). | No | `null` | | `--lifespan` | Optional configuration override for 'lifespan' setting (integer representing hours). Defaults to workspace lifespan setting. | No | `null` | -Run `tw studios start-as-new -h` to view the required and optional fields for adding and starting a new session from an existing session checkpoint. +Run `tw studios add-as-new -h` to view the required and optional fields for adding and starting a new session from an existing session checkpoint. Add a new session from an existing parent Studio session and checkpoint. Useful for experimentation without impacting the parent Studio session state. @@ -203,7 +204,7 @@ tw studios add [OPTIONS] | `--private` | Create a private studio that only you can access or manage (default: false) | No | `false` | | `--labels` | Comma-separated list of labels | No | `null` | | `--wait` | Wait until Studio is in RUNNING status. Valid options: STARTING, RUNNING, STOPPED, STOPPING. | 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). Studios are not available in personal workspaces. | No | `TOWER_WORKSPACE_ID` | | `-t`, `--template` | Container image template to be used for Studio. Available templates can be listed with 'studios templates' command. | No | `null` | | `-ct`, `--custom-template` | Custom container image template to be used for Studio. | No | `null` | | `--gpu` | Optional configuration override for 'gpu' setting (integer representing number of cores). | No | `null` | @@ -235,21 +236,6 @@ Example output: Studio 2aa60bb7 CREATED at [community / showcase] workspace. ``` -## tw studios templates - -List available studio templates. - -```bash -tw studios templates [OPTIONS] -``` - -### Options - -| Option | Description | Required | Default | -|--------|-------------|----------|----------| -| `--max` | Maximum number of templates to return, defaults to 20. | No | `20` | -| `-w`, `--workspace` | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to `TOWER_WORKSPACE_ID` environment variable) | No | `TOWER_WORKSPACE_ID` | - ## tw studios checkpoints List studio checkpoints. @@ -263,13 +249,36 @@ tw studios checkpoints [OPTIONS] | Option | Description | Required | Default | |--------|-------------|----------|----------| | `-f`, `--filter` | Optional filter criteria, allowing free text search on name and keywords: `after: YYYY-MM-DD`, `before: YYYY-MM-DD` and `author`. Example keyword usage: -f author:my-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). Studios are not available in personal workspaces. | No | `TOWER_WORKSPACE_ID` | | `-i`, `--id` | Studio session identifier | No | `null` | | `-n`, `--name` | Studio name | No | `null` | | `--page` | Page number for paginated results (default: 1) | No | `null` | | `--offset` | Row offset for paginated results (default: 0) | No | `null` | | `--max` | Maximum number of records to display (default: ) | No | `null` | +Run `tw studios checkpoints -h` to view the required and optional fields for viewing checkpoints for a session. + +List all checkpoints for an existing Studio session in a workspace. See [Session checkpoints](https://docs.seqera.io/platform-cloud/studios/managing#studio-session-checkpoints) for more information. + +### Example + +Command: + +```bash +tw studios checkpoints -i 9s0t1u2v -w 123456789012345 +``` + +Example output: + +```bash +Checkpoints for studio '9s0t1u2v' at [my-organization / my-workspace] workspace: + +ID | Name | Created +---------------+---------------------+------------------------------- +1a2b3c4d5e | checkpoint-001 | Mon, 15 Jan 2024 10:30:00 GMT +2b3c4d5e6f | checkpoint-002 | Mon, 15 Jan 2024 14:45:00 GMT +``` + ## tw studios add-as-new Add a studio from an existing one. @@ -291,7 +300,7 @@ tw studios add-as-new [OPTIONS] | `--wait` | Wait until Studio is in RUNNING status. Valid options: STARTING, RUNNING, STOPPED, STOPPING. | No | `null` | | `-pid`, `--parent-id` | Parent studio session identifier | No | `null` | | `-pn`, `--parent-name` | Parent studio 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). Studios are not available in personal workspaces. | No | `TOWER_WORKSPACE_ID` | | `--gpu` | Optional configuration override for 'gpu' setting (integer representing number of cores). | No | `null` | | `--cpu` | Optional configuration override for 'cpu' setting (integer representing number of cores). | No | `null` | | `--memory` | Optional configuration override for 'memory' setting (integer representing memory in MBs). | No | `null` | @@ -310,7 +319,7 @@ tw studios stop [OPTIONS] | Option | Description | Required | Default | |--------|-------------|----------|----------| | `--wait` | Wait until given status or fail. Valid options: STARTING, RUNNING, STOPPED, STOPPING. | 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). Studios are not available in personal workspaces. | No | `TOWER_WORKSPACE_ID` | | `-i`, `--id` | Studio session identifier | No | `null` | | `-n`, `--name` | Studio name | No | `null` | @@ -344,7 +353,7 @@ tw studios delete [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). Studios are not available in personal workspaces. | No | `TOWER_WORKSPACE_ID` | | `-i`, `--id` | Studio session identifier | No | `null` | | `-n`, `--name` | Studio name | No | `null` | diff --git a/platform-cli-docs/docs/reference/teams.md b/platform-cli-docs/docs/reference/teams.md index 3396678cb..983545898 100644 --- a/platform-cli-docs/docs/reference/teams.md +++ b/platform-cli-docs/docs/reference/teams.md @@ -159,6 +159,22 @@ tw teams members add [OPTIONS] | Option | Description | Required | Default | |--------|-------------|----------|----------| | `-m`, `--member` | Member username or email address. The user must already be a member of the organization before being added to the team. Use either their platform username or email address. | Yes | `null` | +| `-t`, `--team` | Team name or identifier to add the member to. | Yes | `null` | +| `-o`, `--organization` | Organization name or identifier where the team exists. | Yes | `null` | + +### Example + +Command: + +```bash +tw teams members add -m user1@example.com -t my-team -o my-organization +``` + +Example output: + +```bash +Member 'user1@example.com' added to team 'my-team' in organization 'my-organization' +``` ### tw teams members delete @@ -173,3 +189,19 @@ tw teams members delete [OPTIONS] | Option | Description | Required | Default | |--------|-------------|----------|----------| | `-m`, `--member` | Member username to remove from team. Removes the user from this team but does not remove them from the organization. They will lose access to workspaces shared with this team. | Yes | `null` | +| `-t`, `--team` | Team name or identifier to remove the member from. | Yes | `null` | +| `-o`, `--organization` | Organization name or identifier where the team exists. | Yes | `null` | + +### Example + +Command: + +```bash +tw teams members delete -m user1@example.com -t my-team -o my-organization +``` + +Example output: + +```bash +Member 'user1@example.com' removed from team 'my-team' in organization 'my-organization' +``` diff --git a/platform-cli-docs/docs/reference/workspaces.md b/platform-cli-docs/docs/reference/workspaces.md index 48efa4515..856ad11e0 100644 --- a/platform-cli-docs/docs/reference/workspaces.md +++ b/platform-cli-docs/docs/reference/workspaces.md @@ -43,21 +43,6 @@ Workspaces for default user: 26002603030407 | shared-workspace | my-tower-org | 04303000612070 ``` -## tw workspaces delete - -Delete a workspace. - -```bash -tw workspaces delete [OPTIONS] -``` - -### Options - -| Option | Description | Required | Default | -|--------|-------------|----------|----------| -| `-i`, `--id` | Workspace identifier | No | `null` | -| `-n`, `--name` | Workspace namespace in OrganizationName/WorkspaceName format | No | `null` | - ## tw workspaces add Add a workspace. @@ -103,23 +88,6 @@ A 'SHARED' workspace 'shared-workspace' added for 'my-tower-org' organization By default, a workspace is set to private when created. ::: -## tw workspaces update - -Update a workspace. - -```bash -tw workspaces update [OPTIONS] -``` - -### Options - -| Option | Description | Required | Default | -|--------|-------------|----------|----------| -| `-i`, `--id` | Workspace identifier | Yes | `null` | -| `--new-name` | Updated workspace name. Must be unique per workspace. Names consist of alphanumeric, hyphen, and underscore characters. Must be 2-40 characters. | No | `null` | -| `-f`, `--fullName` | Updated full display name for the workspace. Maximum 100 characters. | No | `null` | -| `-d`, `--description` | Updated workspace description. Maximum 1000 characters. | No | `null` | - ## tw workspaces view View workspace details.