Skip to main content

tw organizations

Run tw organizations -h to view supported workspace operations.

Organizations are the top-level structure and contain workspaces, members, and teams. You can also add external collaborators to an organization. See Organization management for more information.

tw organizations list

List organizations.

tw organizations list [OPTIONS]

Example

tw organizations list

# Output:
Organizations for user-name user:

ID | Name
-----------------+------------------------------
111222333444556 | organization1
111222333444557 | organization7
111222333444558 | organization8
111222333444559 | organization3
111222333444560 | organization2
111222333444561 | organization4
111222333444555 | my-organization
111222333444562 | organization5

tw organizations add

Add an organization.

tw organizations add [OPTIONS]

Options

OptionDescriptionRequiredDefault
-n, --nameOrganization unique name. Must be unique across Seqera Platform. Used as the organization identifier in URLs and API calls. Cannot be changed after creation without --new-name.
-f, --full-nameOrganization display name. The full, human-readable name for the organization shown in the UI. Can contain spaces and special characters.
--overwriteOverwrite existing organization. If an organization with this name already exists, delete it first before creating the new one. Use with caution as this permanently deletes the existing organization and all associated data.false
-d, --descriptionOrganization description. Free-text description providing context about the organization's purpose, team, or projects.
-l, --locationOrganization location. Geographic location or region where the organization is based (e.g., 'San Francisco, CA' or 'EU').
-w, --websiteOrganization website URL. Public website or documentation site for the organization. Must be a valid URL (e.g., https://example.com).

Run tw organizations add -h to view the required and optional fields for adding your workspace.

tw organizations add -n TestOrg2 -f 2nd\ Test\ Organization\ LLC -l RSA

Organization 'TestOrg2' with ID '204336622618177' was added

tw organizations view

View organization details.

tw organizations view [OPTIONS]

Options

OptionDescriptionRequiredDefault
-i, --idOrganization numeric identifier. The unique ID assigned when the organization was created.
-n, --nameOrganization name. The unique organization name used as a human-readable identifier.

Example

tw organizations view -n my-organization

# Output:
Details for organization 'My organization LLC'

-------------+---------------------------------------------------
ID | 111222333444555
Name | my-organization
Full Name | My organization LLC
Description | Organization created with seqerakit CLI scripting
Website | https://example.com/

tw organizations update

Update an organization.

tw organizations update [OPTIONS]

Options

OptionDescriptionRequiredDefault
--new-nameNew unique name for the organization. Changes the organization's identifier. Must be unique across Seqera Platform. Updates URLs and API references.
-f, --full-nameNew display name for the organization. The full, human-readable name shown in the UI. Can contain spaces and special characters.
-i, --idOrganization numeric identifier. The unique ID assigned when the organization was created.
-n, --nameOrganization name. The unique organization name used as a human-readable identifier.
-d, --descriptionOrganization description. Free-text description providing context about the organization's purpose, team, or projects.
-l, --locationOrganization location. Geographic location or region where the organization is based (e.g., 'San Francisco, CA' or 'EU').
-w, --websiteOrganization website URL. Public website or documentation site for the organization. Must be a valid URL (e.g., https://example.com).

Example

tw organizations update -n my-organization --new-name=my-organization-updated

# Output:
Organization 'my-organization' was updated

tw organizations delete

Delete an organization.

tw organizations delete [OPTIONS]

Options

OptionDescriptionRequiredDefault
-i, --idOrganization numeric identifier. The unique ID assigned when the organization was created.
-n, --nameOrganization name. The unique organization name used as a human-readable identifier.

Example

tw organizations delete -n organization4

# Output:
Organization 'organization4' deleted