LinuxCommandLibrary

pio-system

Manage and control PlatformIO system

TLDR

Install shell completion for the current shell (supports Bash, fish, Zsh and PowerShell)

$ pio system completion install
copy

Uninstall shell completion for the current shell
$ pio system completion uninstall
copy

Display system-wide PlatformIO information
$ pio system info
copy

Remove unused PlatformIO data
$ pio system prune
copy

Remove only cached data
$ pio system prune --cache
copy

List unused PlatformIO data that would be removed but do not actually remove it
$ pio system prune --dry-run
copy

SYNOPSIS

pio system {command}

PARAMETERS

info
    Display system information about PlatformIO Core and its environment. This includes Python version, PlatformIO Core version, OS information, and paths to important directories.

prune
    Remove unused packages and dependencies installed by PlatformIO Core to reclaim disk space.

uninstall
    Completely uninstall PlatformIO Core from the system. This removes all installed components and configurations.

update
    Update PlatformIO Core to the latest available version. This ensures that you have the most recent features and bug fixes.

fix-permissions
    Fix file permissions for the PlatformIO Core installation. This can be useful to resolve permission related issues when installing components.

completion
    Print shell completion script.

DESCRIPTION

The pio-system command is a PlatformIO Core command-line tool used to manage its own installation, including updating, uninstalling, and repairing the core. It is essential for maintaining a working PlatformIO environment.

It allows users to easily ensure they have the latest version of PlatformIO Core, resolve installation issues that may arise, or completely remove PlatformIO Core from their system. This command simplifies the process of managing the underlying PlatformIO installation, abstracting away the complexities of manual installation and configuration.

CAVEATS

Some commands, such as 'uninstall', may require administrative privileges to complete successfully.

TROUBLESHOOTING

If you encounter issues with PlatformIO, the pio system info command is helpful for providing the PlatformIO team with important system information to diagnose the problem.

If you are facing permission issues, try pio system fix-permissions command.

SEE ALSO

pio(1)

Copied to clipboard