LinuxCommandLibrary

pio-team

Manage PlatformIO accounts and organizations

TLDR

Create a new team with the specified description

$ pio team create --description [description] [organization_name]:[team_name]
copy

Delete a team
$ pio team destroy [organization_name]:[team_name]
copy

Add a new user to a team
$ pio team add [organization_name]:[team_name] [username]
copy

Remove a user from a team
$ pio team remove [organization_name]:[team_name] [username]
copy

List all teams that the user is part of and their members
$ pio team list
copy

List all teams in an organization
$ pio team list [organization_name]
copy

Rename a team
$ pio team update --name [new_team_name] [organization_name]:[team_name]
copy

Change the description of a team
$ pio team update --description [new_description] [organization_name]:[team_name]
copy

SYNOPSIS

pio team <command> [options]

PARAMETERS

-n, --name
    Specifies the unique name of the target team for the operation.

-e, --email
    Provides the email address of the team member to invite, update, or remove.

-r, --role
    Sets or updates the role for a team member. Common roles include
member
and
admin
(administrator).

--json
    Outputs the command's result in JSON format, useful for programmatic consumption (primarily with
list
subcommand).

DESCRIPTION

The
pio team
command is a crucial subcommand within the PlatformIO Core Command Line Interface (CLI), designed for the comprehensive management of PlatformIO Cloud teams. It empowers users to create, list, and modify their organizational structures within the PlatformIO ecosystem, facilitating collaborative embedded development.

This command provides functionalities for administering team members, including sending invitations to new users, updating their roles (such as
administrator
or
member
), and removing them from a team. It is indispensable for organizations leveraging PlatformIO Cloud services to streamline workflows, securely share projects, and manage access permissions across development teams, ensuring efficient and collaborative work on embedded systems projects.

CAVEATS

Requirements: An active PlatformIO Cloud subscription and a successful authentication via
pio account login
.
Connectivity: Internet connectivity is mandatory for all operations as it interacts with PlatformIO Cloud services.
Permissions: Users must possess the necessary team permissions (e.g., an
admin
role) to perform team and member management actions.

SUBCOMMANDS

The
pio team
command acts as a parent, offering several specialized subcommands for specific actions:
list: Displays a list of all teams the authenticated user is currently a part of.
invite: Sends an invitation to a new user to join a specified team.
update: Modifies the role of an existing member within a team.
remove: Removes a specific member from a team.
init: Initializes and creates a new PlatformIO Cloud team.

HISTORY

PlatformIO, an open-source ecosystem for IoT development, was initially released in 2014. The
pio team
functionality emerged as an integral part of the PlatformIO Cloud services, which expanded the PlatformIO CLI's capabilities to encompass collaborative features. This development was a response to the growing demand for team-based embedded software development and project sharing, marking PlatformIO's evolution from a local development environment into a more integrated, cloud-enabled platform.

SEE ALSO

pio(1), pio account(1), pio cloud(1)

Copied to clipboard