LinuxCommandLibrary

pio-org

Manage PlatformIO organizations

TLDR

Create a new organization

$ pio org create [organization_name]
copy

Delete an organization
$ pio org destroy [organization_name]
copy

Add a user to an organization
$ pio org add [organization_name] [username]
copy

Remove a user from an organization
$ pio org remove [organization_name] [username]
copy

List all organizations the current user is a member of and their owners
$ pio org list
copy

Update the name, email, or display name of an organization
$ pio org update --orgname [new_organization_name] --email [new_email] --displayname [new_display_name] [organization_name]
copy

SYNOPSIS

pio org SUBCOMMAND [OPTIONS] [ARGS]

SUBCOMMANDS:
create, list, show, invite, members, remove-member, leave

PARAMETERS

create <ORGNAME>
    Create a new organization with given name

--description <TEXT>
    Set organization description (create subcommand)

--billing-plan <PLAN>
    Specify billing plan ID (create subcommand)

list
    List all accessible organizations

--org
    Filter list to specific organization

show <ORGNAME>
    Display organization details

--projects
    Include projects list (show subcommand)

invite <ORGNAME> <USERNAME>
    Invite user to organization

--role <ROLE>
    Set role: owner|member (invite/members)

members <ORGNAME>
    List organization members

remove-member <ORGNAME> <USERNAME>
    Remove member from organization

leave <ORGNAME>
    Leave the organization

-h, --help
    Show command help

-v, --verbose
    Enable verbose output

--force
    Force operation without prompts

--non-interactive
    Disable interactive prompts

DESCRIPTION

The pio org command is part of the PlatformIO CLI, an open-source ecosystem for embedded and IoT development. It enables users to manage organizations on the PlatformIO platform, which are collaborative spaces for teams to share projects, libraries, and resources securely.

Organizations support member roles (owner, member), billing plans for private projects, and integration with PlatformIO's cloud services. Common workflows include creating an org for a team, inviting developers by username, listing accessible orgs, viewing details/members, and managing memberships.

This command requires a logged-in PlatformIO account (pio account login) and internet access. It's essential for professional teams scaling beyond individual projects, offering features like project visibility controls and unified billing.

Usage integrates with other pio commands, e.g., pio project init --board ... --org <orgname> to init projects under an org.

CAVEATS

Requires PlatformIO Core installation, active internet, and logged-in account. Organizations may incur costs for premium plans. Owner cannot remove self without transferring ownership.

EXAMPLES

pio org create MyTeam --description "IoT Team"
pio org invite MyTeam user@example.com --role member
pio org list

REQUIREMENTS

PlatformIO Core ≥5.0, Python 3.6+, PlatformIO account.

HISTORY

Introduced in PlatformIO Core 4.0 (2019) to support team features. PlatformIO founded in 2014 by Ivan Kravets; org management evolved with cloud platform in v5+ for enterprise use.

SEE ALSO

pio(1), pio account(1), pio project(1)

Copied to clipboard