Introduction
WS.Eng CLI is a general automation framework that enforces engineering standards and automates bureaucracy across JIRA/GitHub workflows.
What It Does
The CLI started as a tool for sharing AI-based prompts and operations between engineers. It has evolved into a comprehensive automation framework that handles the complexity of linking JIRA/GitHub, managing ticket lifecycles, and maintaining engineering standards across teams.
Core capabilities:
- Ticket lifecycle automation: Create branches, pull requests, and download context in one command
- Standard enforcement: Consistent commit messages, changelog generation, code review patterns
- Cross-system integration: Seamlessly works across JIRA/GitHub during platform migrations
- AI-powered workflows: Question answering, code review, automated testing
Your First Workflow
Here's the most common workflow using the CLI:
# Start working on a ticket
wseng start LAMBDA-12345
# Creates branch, PR, downloads ticket context locally
# Make your code changes...
# Commit with AI-generated message
wseng commit
# Generate changelog and update ticket
wseng changelog
# Record acceptance demo
wseng demo
The CLI handles all complexity of linking JIRA/GitHub artifacts, updating ticket fields, and maintaining traceability.
Who Should Use This
Primary users: Engineers working on WS.Eng projects who need to:
- Manage JIRA/GitHub tickets efficiently
- Follow standardized workflows
- Automate repetitive tasks (commits, changelogs, reviews)
Secondary users: Engineering managers who need to:
- Query project status and engineer workload
- Access team data through the Data API
- Monitor ticket progress programmatically
How It Works
The CLI operates in three modes:
1. Local Command-Line Tool
Install globally with pnpm, run commands directly:
wseng start-ticket LAMBDA-12345
wseng commit --type feature
wseng review-work
2. GitHub Actions
Use in CI/CD pipelines for automated reviews, deployments:
- uses: trilogy-group/ws-eng-cli@main
with:
command: wseng review-work
3. REST API
The CLI is also deployed as a REST API where commands become endpoints. Includes:
- Command endpoints: Execute any CLI command remotely
- Data API: Query core objects (people, projects, tickets, status)
What Makes It Different
No manual coordination: The CLI knows about your AWS environments, JIRA/GitHub state, code repositories, and team structure. You focus on the task, not the glue.
Migration-ready: Currently supporting transition from JIRA to GitHub Issues. Commands work regardless of which ticketing system a project uses.
Extensible: Built on TypeScript with many reusable services. Engineers regularly extend the CLI with custom commands for their projects.
Related Docs
Installation
Install prerequisites, set up the CLI, and run your first command.
Ticket Lifecycle Workflow
Detailed walkthrough of the standard ticket workflow from start to delivery.