@wipefest/cli v0.15.11

Wipefest CLI

This repository contains the code for the @wipefest/cli NPM package, which can be installed to allow CLI access to Warcraft Logs data, and to process that data using Wipefest.

Usage

Install via NPM:

npm install -g @wipefest/cli

Output help:

wipefest --help

The CLI decides which command to run based on which arguments you provide.

Retrieve a report:

wipefest --report aHMJNvVqGFXKtPzY --wcl-api-key YOUR_WCL_API_KEY

Retrieve and process a fight:

wipefest --report aHMJNvVqGFXKtPzY --fight 15 --wcl-api-key YOUR_WCL_API_KEY

Replace YOUR_WCL_API_KEY with your Warcraft Logs Public Key found here.

Currently most output is JSON, which gives you the most information possible and allows other applications to consume it, however, the fight command supports outputting to a human-readable format using --output human:

wipefest --report aHMJNvVqGFXKtPzY --fight 15 --output human --wcl-api-key YOUR_WCL_API_KEY

Outputs:

MYTHIC THE DEFENSE OF EONAR
------------------------------------------
INSIGHTS
- Sent 4 teams to board the Paraxis.
- Hit by <http://wowhead.com/spell=248329> Rain of Fel 15 times (except after gaining <http://wowhead.com/spell=248332> Rain of Fel).
- Stood in <http://wowhead.com/spell=248795> Fel Wake 109 times.
- Non-Tanks hit by <http://wowhead.com/spell=250703> Fel Swipe 1 time.
- Interrupted <http://wowhead.com/spell=246305> Artillery Strike 16/17 times.
------------------------------------------
TIMELINE
0:35 - Xénubis interrupts Artillery Strike
0:52 - Heskeey interrupts Artillery Strike (2)
0:59 - Plannk interrupts Artillery Strike (3)
1:35 - Garrow gains Feedback - Burning Embers
1:36 - Raekón gains Feedback - Foul Steps
1:40 - Dissi gains Feedback - Arcane Singularity
1:45 - The Paraxis damaged by Life Force (57835068)
1:46 - Yaykhayla gains Feedback - Targeted
2:10 - The Paraxis casts Purge

...

Contribute

The best way to contribute is to get in touch on our Discord server.

To download the source code and run the application:

git clone https://github.com/JoshYaxley/Wipefest.Core.git
cd Wipefest.Core/cli
npm install
node cli.js --help

If you are using Visual Studio Code, you can debug the API by pressing F5.

This module depends on:

• @wipefest/core for Warcraft Logs data retrieval and Wipefest processing
  • axios for HTTP requests
  • rxjs for Observables
• commander for CLI