LinuxCommandLibrary

pio-account

Manage PlatformIO user account

TLDR

Register a new PlatformIO account

$ pio account register [[-u|--username]] [username] [[-e|--email]] [email] [[-p|--password]] [password] --firstname [firstname] --lastname [lastname]
copy

Permanently delete your PlatformIO account and related data
$ pio account destroy
copy

Log in to your PlatformIO account
$ pio account login [[-u|--username]] [username] [[-p|--password]] [password]
copy

Log out of your PlatformIO account
$ pio account logout
copy

Update your PlatformIO profile
$ pio account update [[-u|--username]] [username] [[-e|--email]] [email] --firstname [firstname] --lastname [lastname] --current-password [password]
copy

Show detailed information about your PlatformIO account
$ pio account show
copy

Reset your password using your username or email
$ pio account forgot [[-u|--username]] [username_or_email]
copy

SYNOPSIS

pio account [OPTIONS] COMMAND [ARGS]...

PARAMETERS

--json
    Returns the command output in JSON format, useful for scripting and programmatic parsing.

--help
    Displays a help message for the pio account command, detailing its usage, options, and available subcommands.

login
    Authenticates with a PlatformIO account. This subcommand typically prompts for email/username and password to establish a session.

logout
    Logs out from the currently authenticated PlatformIO account, removing local authentication credentials.

token
    Manages PlatformIO account API tokens. This subcommand itself has further subcommands to create, list, and revoke tokens.

DESCRIPTION

The pio account command is a crucial subcommand of the PlatformIO command-line interface (CLI), designed to facilitate user interaction with PlatformIO's cloud services. It primarily manages user authentication, allowing users to log in to their PlatformIO accounts, log out, and securely manage API tokens.

This command is indispensable for developers utilizing PlatformIO's advanced features, such as remote development, private package registries, continuous integration/continuous delivery (CI/CD) pipelines, and syncing project data across environments. By handling authentication credentials and API tokens locally, pio account ensures secure and seamless access to these cloud-dependent functionalities, making it an integral part of a comprehensive embedded development workflow.

CAVEATS

The command typically invoked is pio account, not pio-account. pio-account as a standalone binary is not standard within the PlatformIO ecosystem.
Requires PlatformIO Core CLI to be installed and accessible in the system's PATH. Full functionality requires an active PlatformIO account.

SUBCOMMANDS OF 'PIO ACCOUNT TOKEN'

The token subcommand within pio account offers further operations for managing API tokens:

pio account token create: Creates a new API token for programmatic access to PlatformIO services.
pio account token list: Lists all active API tokens associated with the account.
pio account token revoke: Revokes a specific API token, invalidating it immediately.

HISTORY

The PlatformIO CLI, including its account management capabilities, has evolved significantly since its inception. The pio account functionality was introduced and enhanced as PlatformIO expanded its ecosystem to include cloud-based services like remote development, private registries, and CI/CD integration. Its development reflects the growing need for seamless and secure authentication to these online features, becoming a core component for users leveraging PlatformIO's broader capabilities.

SEE ALSO

pio(1), pio run(1), pio init(1)

Copied to clipboard