2. CLI Development Guide

Introduction

This wiki will get you up to speed with how the CLI is structured and guide you in setting up the subproject

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You should've already installed the requirements for the monorepo. If you have not, refer to this wiki.

Installing

At the root of the tracerbench monorepo folder

cd packages/cli/
tsc -b tsconfig.json
./bin/run -h

You should be seeing the following output in the terminal

CLI for Tracerbench

VERSION
  tracerbench-cli/2.0.0-beta.6 darwin-x64 node-v10.15.3

USAGE
  $ tracerbench [COMMAND]

COMMANDS
  analyze         Parses a CPU profile and aggregates time across heuristics. Can be vertically sliced with event names.
  compare         Compare the performance delta between an experiment and control
  create-archive  Creates an automated HAR file from a URL.
  css-parse       Aggregates CSS parsing time from a trace.
  help            display help for tracerbench
  js-eval-time    Aggregates JS Eval time from a trace.
  list-functions  Lists all the functions and source locations from a trace.
  timeline        Get frame id from trace JSON file and url.
  trace           Creates an automated trace JSON file. Also takes network conditioner and CPU throttling options.

Running the tests

#TODO

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Built With

• oclif - A framework for building CLIs in Node.js.

#TODO add more

Contributing

#TODO

Versioning

Lock step mention? #TODO

Authors

#TODO

License

#TODO