CoE CLI development (Deprecated)

Article
05/24/2023

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.

This section outlines the following key sections on the CoE CLI. The information below can help guide you in making contributions back to the open-source repository.

Quick start - Provides a set of links to the technology used to build and test the CLI.
Development environment set-up - How to edit the CLI using Visual Studio Code.
Adding a new command - How to add a new CLI command.
Documentation - Adding documentation for commands.

Quick start

The coe-cli command-line application makes use of following components.

NodeJS to provide cross-platform support.
TypeScript to use published type definitions for dependent components.
Jest for unit tests.

Initial commands

Download or clone coe-starter-kit.
Go to the coe-cli folder.
```
cd coe-cli
```
Install dependent components.
```
npm install
```
Build from the source code.
```
npm run build
```
Install the coe command.
```
npm link
```

Understand the concepts

Documentation

Documentation is critical for users of the CoE understanding the commands. The documentation pages describe how to add or modify CoE CLI.

Development frameworks

If you're new to TypeScript, the following links may help.

If you're new to unit testing with Jest, start with this article.

Jest getting started

Development environment set-up

Edit and debug the CLI using Visual Studio Code.

If you don't have Visual Studio Code, download it at https://code.visualstudio.com/Download.
Once installed, open the coe-cli folder in Visual Studio Code.
The .vscode/launch.json file contains a preconfigured debug launch command.
You can edit the sample.json file to the commands that you want to debug.
Place breakpoints in the TypeScript files you want to debug, and then press F5 to start debugging.

Notes

Depending on the command you want to debug, you might be prompted to sign in to the DEBUG CONSOLE.
If you're testing with a different account, you'll need to sign out of any existing Azure CLI sessions.
```
az logout
```

Debugging commands

You can debug the coe-cli application commands using Visual Studio Code.

Change the sample.json to the command or commands you want to run.
Open the coe-cli folder in Visual Studio Code.
Place breakpoints in the TypeScript code you want to debug.
Press F5 or select Run > Start Debugging.