Skip to main content

Portals CLI

The Portals CLI is a command-line tool designed to simplify and streamline the management and deployment of your Portals projects. It empowers developers to interact with Portals programmatically, automating common tasks and enhancing productivity. The CLI provides functionality for both Native Developers and Web Developers.

The CLI is a companion tool but is not required to use Portals.


Installing the Ionic Portals CLI is a straightforward process, with options available for macOS, Linux, Windows, and various distribution methods to suit your preferences. Here's how to get started on your platform of choice:


If you're using macOS or Linux, you can streamline the installation process with Homebrew. First, tap into the Portals releases repository and then install Portals with these commands:

# tap the Portals releases repository
brew tap ionic-team/portals

# install
brew install portals

Shell script

Another option for macOS and Linux users is the shell script-based installation. Execute this single command to install Portals:

curl -sL | bash

Windows Binaries

For Windows users, manual installation is currently required. You can download the appropriate zip file for your architecture (arm64, i386, or x86_64) from the list provided and extract it to a directory on your system's PATH for convenient access.

Linux Binaries

Debs and RPMs are made available for each release. Download the appropriate package for your system and install with your package manager.

Command List​

View all available CLI commands and options.