Getting StartedWorkflowsExtending the CLICLI ReferenceREST API Reference

Installation

Install and configure WS.Eng CLI for local development.

Prerequisites

Before installing, ensure you have:

  1. Node.js 20 or later (download)
  2. Git 2 or later (download)
  3. GitHub CLI 2 or later (download)
  4. Python 3 or later (download)
  5. AWS Account Access: You must have access to the WS.Eng AWS account (RAM-AWS-Dev-WSEngineering-WSEng-Admin). Reach out to your engineering manager for access. See the AWS setup guide.

Note on Python: Python is currently required to use the CLI. It may be removed in future versions, but for now it must be installed.

Installation Steps

1. Clone the Repository 

git clone https://github.com/trilogy-group/ws-eng-cli.git
cd ws-eng-cli

2. Install Dependencies

The project uses pnpm as its package manager:

# Install pnpm globally (if not already installed)
npm install -g pnpm

# Install project dependencies
pnpm install

3. Link CLI Globally

Make the CLI available system-wide:

pnpm link --global

This creates a global wseng command you can run from any directory.

4. Verify Installation

Check that the CLI is accessible:

wseng --version

You should see the current version number.

Initial Setup

Run Init Command

Initialize the CLI within your project repositories:

cd /path/to/your/project
wseng init

The wseng init command:

  • Creates .wseng configuration files (personal and project-level)
  • Sets up working directory context
  • Prepares the CLI for first use

You can run wseng init multiple times safely. It's the bridge between installation and configuration.

Verify Setup

Run a simple command to confirm everything works:

wseng --help

You should see the full list of available commands grouped by category.

Common Installation Issues

❌ Bad: wseng: command not found

This means global linking failed.

Solution:

cd ws-eng-cli
pnpm link --global

# Verify pnpm's global bin directory is in PATH
pnpm root -g

Add pnpm's global bin directory to your PATH if needed.

❌ Bad: Python not found errors

Some CLI commands require Python.

Solution:

Install Python 3 from python.org, then verify:

python --version
# or
python3 --version

❌ Bad: Permission errors during pnpm install

Solution:

# Don't use sudo with pnpm
# Instead, fix npm/pnpm permissions:
mkdir ~/.pnpm-global
pnpm config set store-dir ~/.pnpm-global

Next Steps

After installation, you need to authenticate with AWS, GitHub, and optionally Google to unlock full CLI functionality.

Related Docs

Authentication

Set up AWS profiles, GitHub CLI login, and Google authentication.

Configuration

Understand .wseng configuration files and customize CLI behavior.

Ticket Lifecycle Workflow

Start using the CLI for your first ticket.