Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Update README.md #222

Merged
merged 3 commits into from
Sep 4, 2020
Merged

Update README.md #222

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
412f9cd
Update README.md
VijayanB Sep 3, 2020
3bb21e6
Update README.md
VijayanB Sep 3, 2020
c29625e
Update installation instructions
VijayanB Sep 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,29 @@ Users can run this CLI from MacOS, Windows, Linux and connect to any valid Elast

Launch your local Elasticsearch instance and make sure you have the Open Distro for Elasticsearch AD plugin installed.

To install the AD CLI:
To install and set-up AD CLI:


1. Install from source:
1. Download and extract esad Binaries

```
$ go get github.com/opendistro-for-elasticsearch/anomaly-detection/cli
Download esad binaries suitable for your system from https://github.com/opendistro-for-elasticsearch/anomaly-detection/actions/runs/224422434
```

2. Make esad executable

```
chmod +x ./esad

```
3. Move the binary in to your PATH.
```
sudo mv ./esad /usr/local/bin/esad
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This requires user have enough permission to move esad to local bin folder. How about add another option for user who has no sudo permission? Will be a blocker for some user if AD CLI must need sudo permission.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack


```
4. Test to ensure the version you installed is up-to-date:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we show the version is update to date or not with command esad --version ? Or we just show version info, user need to figure out by themselves?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the step now. Can you review it again?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks

```
esad --version
```

## Configure
Expand Down