Install the CoE CLI (Deprecated)

Note

The CoE CLI is deprecated and will be removed in a future release. Use the Power Platform Project Setup Wizard to set up and manage your ALM Accelerator for Power Platform projects.

To install the Center of Excellence (CoE) command line interface (CLI):

1. Download the CoE Starter Kit compressed file.

2. Extract the zip file.

3. Open the extracted folder and then navigate to the coe-cli folder.

   cd coe-cli
   

Perform a local install or Docker install.

Local install

If you don't have administrative privileges, make sure you install the prerequisites for a non-administrator. The installation instructions are the same for both administrator and non-administrator installs.

Prerequisites as administrator

• Node.js 16+, available at https://nodejs.org/en/download/

• Azure CLI (version 2.37.0+). You need Azure CLI for user authentication and Microsoft Entra integration. Follow the installation instructions for your operating system in How to install the Azure CLI.

  Important

  The CoE CLI works with Azure CLI versions up to 2.38.0.

• PowerShell Core (version 7.2+), available from Install PowerShell on Windows, Linux, and macOS.

• Git CLI (version 2.37.2+), available at https://git-scm.com/downloads.

To check that you installed the prerequisites correctly and have the right versions, issue the following commands at the command prompt.

1. Verify the node version:

   node --version
   

2. Verify the Azure CLI version:

   az --version
   

Prerequisites for a non-administrator

• Miniconda, a free bootstrap version of Anaconda that includes only conda, Python, the packages they depend on, and a few other useful packages.

• Node.js 16+. To install:

  • Download Node.js.
  • Download the Windows binary for your operating system.
  • Extract the downloaded zip file.
  • In Windows Explorer, open %USERPROFILE%.
  • Create a folder named nodejs.
  • Copy all files from the zip file into the nodejs folder.

• Azure CLI. Install by using pip, the Python package manager:

  pip install azure-cli
  

• Prepare your system:

  1. Open %USERPROFILE%\dev.bat with a text editor like Notepad and make the following edit:

     SET PATH=%PATH%;%USERPROFILE%/nodejs
     %windir%\System32\cmd.exe "/K" %USERPROFILE%\miniconda3\Scripts\activate.bat %USERPROFILE%\miniconda3
     

  2. Save the file.

To check that you installed the prerequisites correctly and have the right versions, use the following commands:

az --version
node --version
pac --version

Install

For a demo of the steps, go to Video demo of local installation.

1. Start from the coe-cli folder.

   cd coe-cli
   

2. Install application dependencies:

   npm install
   

3. Build the application:

   npm run build
   

4. Link to the CoE CLI application:

   npm  link
   

5. Verify that the CoE CLI is installed:

   coe --help    
   

Note

On Windows, you might need to add %APPDATA%\npm to your PATH environment variable to access the coe command.

Video demo of local installation

The following demo shows the results of a sample local install.

Docker install

Another way to install the CoE CLI is using Docker. For a demo of the steps, go to Video demo of Docker installation.

Prerequisites

To run the CoE CLI application, you need to install Docker locally. You can use either the Community Edition or Enterprise Edition. If you're installing on a desktop environment, choose Community Edition.

Docker install steps

Note

On some operating systems, you might need to use sudo before each of the Docker commands.

1. Build docker image:

   cd coe-cli
   docker build -t coe-cli . 
   

2. Use the docker image:

   docker run -it --rm coe-cli
   

   This command starts a new interactive console (-it) and removes the Docker container (--rm) when the console session exits. Using --rm removes any cached credentials when you exit.

Video demo of Docker installation

The following demo shows the results of a sample Docker install on Linux.

Next step

Install the CoE CLI ALM accelerator