wu-sheng commented on a change in pull request #8: Add command manual and documentations URL: https://github.com/apache/skywalking-cli/pull/8#discussion_r344466515
########## File path: README.md ########## @@ -1,18 +1,63 @@ Apache SkyWalking CLI =============== +![](https://github.com/apache/skywalking-cli/workflows/Build/badge.svg?branch=master) +![](https://codecov.io/gh/apache/skywalking-cli/branch/master/graph/badge.svg) + <img src="http://skywalking.apache.org/assets/logo.svg" alt="Sky Walking logo" height="90px" align="right" /> The CLI (Command Line Interface) for [Apache SkyWalking](https://github.com/apache/skywalking). SkyWalking CLI is a command interaction tool for the SkyWalking user or OPS team, as an alternative besides using browser GUI. It is based on SkyWalking [GraphQL query protocol](https://github.com/apache/skywalking-query-protocol), same as GUI. +# Install +As SkyWalking CLI is using `Makefile`, compiling the project is as easy as executing a command in the root directory of the project. + +```shell +git clone https://github.com/apache/skywalking-cli +cd skywalking-cli +make clean && make +``` + +and copy the `./bin/swctl` to your `PATH` directory, usually `/usr/bin/` or `/usr/local/bin`, or you can copy it to any directory you like, +and add that directory to `PATH`. + # Commands -TODO +Commands in SkyWalking CLI are organized into two levels, in the form of `swctl --option <level1> --option <level2> --option`, Review comment: This looks like a design, rather than doc. I think you should re-organize words. Begin with the command tree or table, move the design to another design or contributor doc. Most users don't need to understand this. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services