Installation

Install and configure WS.Eng CLI for local development.

Prerequisites

Before installing, ensure you have:

Node.js 24 or later (download)
Git 2 or later (download)
GitHub CLI 2 or later (download)

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:

npm install -g pnpm
pnpm install

3. Link CLI Globally

pnpm link --global

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

4. Verify Installation

wseng --version

Initial Setup

Run wseng init in a project repository to create configuration and provide your personal TrueFoundry token:

cd /path/to/your/project
wseng init

The token is stored as truefoundryToken in ~/.wseng. The CLI uses your GitHub CLI login for GitHub operations. Run wseng init --google to sign in with your own Google account.

No AWS profile is needed for local use. For details, see Authentication.

You can run wseng init again to update the configuration.

Verify Setup

wseng --help

WSL / Headless Environments

Linux-on-Windows (WSL) and other headless setups need a few deviations from the default instructions:

Install with pnpm add -g ., not pnpm link --global. From the cloned ws-eng-cli directory:
```
pnpm add -g .
```
Use Node 24 via nvm, and do not run pnpm setup. Install Node through nvm and let it manage the global bin directory. Running pnpm setup on top of an nvm-managed Node breaks global installs.

Common Installation Issues

`wseng: command not found`

This means global linking failed.

cd ws-eng-cli
pnpm link --global
pnpm root -g

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

Permission errors during `pnpm install`

Do not use sudo with pnpm. Instead, fix npm/pnpm permissions:

mkdir ~/.pnpm-global
pnpm config set store-dir ~/.pnpm-global

Next Steps

Authenticate with GitHub and provide your TrueFoundry token. Google sign-in is available when needed.

Introduction

Authentication