Add Usage Information to Readme #35

ernestii · 2019-07-04T16:24:35Z

Add the following information to readme:

Usage

Command	Description
`logdna register [email]`	Register a new LogDNA account
`logdna ssologin`	Log in to a LogDNA via single sign-on
`logdna login [email]`	Log in to LogDNA
`logdna tail [options] [query]`	Live tail with optional filtering. Options include `-h`, `-a`, `-l`, `-t` to filter by hosts, apps, levels or tags respectively. Run `logdna tail --help` to learn more.
`logdna switch`	If your login has access to more than one account, this command allows you to switch between them
`logdna search [options] [query]`	Basic search with optional filtering. Run `logdna search --help` for options.
`logdna info`	Show current logged in user info
`logdna update`	Update the CLI to the latest version

Examples

# Register
$ logdna register [email protected]
$ logdna register [email protected] b7c0487cfa5fa7327c9a166c6418598d # use this if you were assigned an Ingestion Key

# Login
$ logdna login [email protected]

# Tail
$ logdna tail '("timed out" OR "connection refused") -request'
$ logdna tail -a access.log 500
$ logdna tail -l error,warn

# Search
$ logdna search "logdna cli" -a logdna.log -t tag1,tag2 -n 300
$ logdna search "logdna" --from 1541100040931 --to 1541102940000

# Other
$ logdna info
$ logdna update

# Switch organization
$ logdna switch

> 1: ACME (active)
> 2: Strickland Propane
> Choose account [1-2]:

smusali

In terms of the validity of the content, all is good but I think @dchai76 is much better at reviewing documentation-related changes - content-wise.

README.md

dchai76

This is great! I love clis.

dchai76 · 2019-07-04T18:10:11Z

README.md

+
+| Command | Description |
+| - | - |
+| `logdna register [email] [key]` | Register a new LogDNA account. `[key]` is optional and will autogenerate. |


I think key could use better explanation. Like, reading this I don't know what it's for and why you would ever specify it. Maybe call it [ingestion_key] to start and say "If you are registering for a new account and don't yet have an ingestion key, this command will create one for you."

Looks like we removed support for the key param some time ago. I'll remove it from here. You can check commit 0c9781a70 on ldapi.

dchai76 · 2019-07-04T18:11:20Z

README.md

+| Command | Description |
+| - | - |
+| `logdna register [email] [key]` | Register a new LogDNA account. `[key]` is optional and will autogenerate. |
+| `logdna ssologin` | Login to a LogDNA user account via single sign-on. |


Let's say Log in to LogDNA via single sign-on

dchai76 · 2019-07-04T18:11:34Z

README.md

+| - | - |
+| `logdna register [email] [key]` | Register a new LogDNA account. `[key]` is optional and will autogenerate. |
+| `logdna ssologin` | Login to a LogDNA user account via single sign-on. |
+| `logdna login [email]` | Login to a LogDNA user account. |


Log in to LogDNA

dchai76 · 2019-07-04T18:12:20Z

README.md

+| `logdna register [email] [key]` | Register a new LogDNA account. `[key]` is optional and will autogenerate. |
+| `logdna ssologin` | Login to a LogDNA user account via single sign-on. |
+| `logdna login [email]` | Login to a LogDNA user account. |
+| `logdna tail [options] [query]` | Live tail with optional filtering. Options include `-h`, `-a`, `-l`, `-t` to filter by hosts, apps, levels or tags respectively. Run `logdna tail -h` to learn more. |


This is kind of confusing - are we re-using -h for both hosts filtering and help instructions? Maybe help should be --help?

Yes, it should be --help

dchai76 · 2019-07-04T18:13:43Z

README.md

+| `logdna ssologin` | Login to a LogDNA user account via single sign-on. |
+| `logdna login [email]` | Login to a LogDNA user account. |
+| `logdna tail [options] [query]` | Live tail with optional filtering. Options include `-h`, `-a`, `-l`, `-t` to filter by hosts, apps, levels or tags respectively. Run `logdna tail -h` to learn more. |
+| `logdna switch` | Switch between multiple accounts if your login has access to more than one. |


If your login has access to more than one account, this command allows you to switch between them.

dchai76 · 2019-07-04T18:14:32Z

README.md

+| `logdna login [email]` | Login to a LogDNA user account. |
+| `logdna tail [options] [query]` | Live tail with optional filtering. Options include `-h`, `-a`, `-l`, `-t` to filter by hosts, apps, levels or tags respectively. Run `logdna tail -h` to learn more. |
+| `logdna switch` | Switch between multiple accounts if your login has access to more than one. |
+| `logdna search [options] [query]` | Limited search functionality with optional filtering. See `logdna search --help`. |


"Basic search with optional filtering. Run logdna search --help for options."

dchai76 · 2019-07-04T18:14:56Z

README.md

+| `logdna switch` | Switch between multiple accounts if your login has access to more than one. |
+| `logdna search [options] [query]` | Limited search functionality with optional filtering. See `logdna search --help`. |
+| `logdna info` | Show current logged in user info. |
+| `logdna update` | Update CLI to latest version. |


"Update the CLI to the latest version."

README.md

dchai76

2 small suggestions, otherwise looks good, let's merge.

dchai76 · 2019-07-05T17:58:47Z

index.js

@@ -20,13 +20,12 @@ process.title = 'logdna';
 program._name = 'logdna';
 program
    .version(pkg.version, '-v, --version')
-    .usage('[commands] [options]\n\n  This CLI duplicates useful functionality of the LogDNA web app.')
-    // .description('This CLI duplicates useful functionality of the LogDNA web app.')
+    .usage('[commands] [options]\n\nThe LogDNA CLI allows you to signup for a new account and tail your servers right from the command line.')


Let's use "sign up" not "signup", and "tail your logs" instead of "tail your servers"

Add usage information to readme

d06aef7

ernestii requested a review from smusali July 4, 2019 16:24

smusali requested a review from dchai76 July 4, 2019 16:25

smusali assigned smusali and ernestii and unassigned smusali Jul 4, 2019

smusali added the enhancement label Jul 4, 2019

smusali suggested changes Jul 4, 2019

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

c7ee6ae

dchai76 suggested changes Jul 4, 2019

View reviewed changes

Ernest Iliiasov added 3 commits July 4, 2019 14:46

Update command descriptions in Readme and CLI

c1e2827

Update index.js

88ccc4d

Fix switch command input validation. Add switch usage example.

7bbe06e

smusali self-requested a review July 4, 2019 21:36

dchai76 approved these changes Jul 5, 2019

View reviewed changes

signup -> sign up, tail your servers -> tail your logs

027ce15

ernestii merged commit f29d71f into master Jul 9, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Usage Information to Readme #35

Add Usage Information to Readme #35

ernestii commented Jul 4, 2019 •

edited

Loading

smusali left a comment

dchai76 left a comment

dchai76 Jul 4, 2019

ernestii Jul 4, 2019

dchai76 Jul 4, 2019

dchai76 Jul 4, 2019

dchai76 Jul 4, 2019

ernestii Jul 4, 2019

dchai76 Jul 4, 2019

dchai76 Jul 4, 2019

dchai76 Jul 4, 2019

dchai76 left a comment

dchai76 Jul 5, 2019

ernestii Jul 5, 2019

Add Usage Information to Readme #35

Add Usage Information to Readme #35

Conversation

ernestii commented Jul 4, 2019 • edited Loading

Usage

Examples

smusali left a comment

Choose a reason for hiding this comment

dchai76 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dchai76 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ernestii commented Jul 4, 2019 •

edited

Loading