Skip to main content

Command Reference

This reference documents all tw CLI commands for managing Seqera Platform resources. Each command page includes detailed descriptions, options, and examples.

note

The CLI performs operations in the user workspace context by default. Use the TOWER_WORKSPACE_ID environment variable or the --workspace parameter to specify an organization workspace ID.

--help flag

Use -h or --help with any command to view available options:

tw --help                         # List all commands
tw <command> -h # Show command options
tw <command> <subcommand> -h # Show subcommand options

Example:

tw runs view -h              # Help for viewing runs
tw pipelines import -h # Help for import subcommand
tw credentials add google -h # Help for specific provider

Commands by Category

Info

  • info - Show system info and health status

Resources

Pipelines & Runs

Organization & Access

Interactive environments

Common Patterns

Output Formats

Export command results to JSON:

tw <command> --output=json

Use with jq for filtering:

tw workspaces list --output=json | jq -r '.workspaces[].orgId'

Workspace Context

Specify workspace by ID:

tw <command> -w 123456789012345

Or by organization/workspace name:

tw <command> -w myorg/myworkspace

Set default workspace:

export TOWER_WORKSPACE_ID=123456789012345

Next Steps

  • See individual command references using the navigation
  • See Installation for setup instructions and Overview for CLI introduction