Skip to content

Commit 19d6c98

Browse files
committed
Update README.md
1 parent e0a2110 commit 19d6c98

File tree

1 file changed

+8
-44
lines changed

1 file changed

+8
-44
lines changed

README.md

+8-44
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,14 @@
88

99
Blazing fast single purpose cli for CloudTrail log filtering, written in golang
1010

11-
# Usage
12-
13-
```bash
14-
$ cloudtrail-cli --version
15-
cloudtrail-cli version 1.0.12
16-
```
11+
## 🚀 Quick start
1712

1813
```bash
1914
$ cloudtrail-cli --help
20-
NAME:
21-
cloudtrail-cli - Blazing fast single purpose cli for CloudTrail log filtering
22-
23-
USAGE:
24-
cloudtrail-cli [global options] command [command options] [arguments...]
25-
26-
VERSION:
27-
1.0.12
28-
29-
COMMANDS:
30-
help, h Shows a list of commands or help for one command
31-
32-
GLOBAL OPTIONS:
33-
--profile value, -p value
34-
--region value, -r value
35-
--start-time value, -s value Timestamp in 2023-01-01T00:00:00 format (UTC)
36-
--end-time value, -e value Timestamp in 2023-01-01T00:00:00 format (UTC)
37-
--event-id value Filter events with event id
38-
--event-name value Filter events with event name
39-
--user-name value Filter events with user name
40-
--event-source value Filter events with event source
41-
--access-key-id value Filter events with access key id
42-
--read-only Filter events with ReadOnly=true (default: false)
43-
--no-read-only Filter events with ReadOnly=false (default: false)
44-
--max-results value, -n value (default: "20")
45-
--error-only Filter events with errors (default: false)
46-
--truncate-user-name Truncate user name string (default: false)
47-
--truncate-user-agent Truncate user agent string (default: false)
48-
--help, -h show help
49-
--version, -v print the version
5015
```
5116

52-
# Sample Output
53-
5417
```bash
55-
$ cloudtrail-cli --start-time 2023-02-01T00:00:00 --end-time 2023-02-01T01:00:00 --event-name AssumeRole --max-results 5 --region us-east-1 --read-only
18+
$ cloudtrail-cli --start-time 2023-02-01T00:00:00 --end-time 2023-02-01T01:00:00 --event-name AssumeRole --max-results 5
5619
+--------------------------------------+------------+----------------------+----------+-------------------+-------------------------------+-------------------------------+-------------+-----------+----------+
5720
| EventId | EventName | EventTime | Username | EventSource | UserAgent | SourceIPAddress | AccessKeyId | ErrorCode | ReadOnly |
5821
+--------------------------------------+------------+----------------------+----------+-------------------+-------------------------------+-------------------------------+-------------+-----------+----------+
@@ -64,17 +27,18 @@ $ cloudtrail-cli --start-time 2023-02-01T00:00:00 --end-time 2023-02-01T01:00:00
6427
+--------------------------------------+------------+----------------------+----------+-------------------+-------------------------------+-------------------------------+-------------+-----------+----------+
6528
```
6629

67-
# Install
30+
## 👷 Install
6831

69-
### Homebrew
32+
### For macOS users (Recommended)
7033

7134
```bash
7235
$ brew tap guessi/tap && brew update && brew install cloudtrail-cli
7336
```
7437

75-
### For non-Homebrew users, click `Details` to view more methods.
38+
### Manually setup (Linux, Windows, macOS)
7639

77-
<details>
40+
<details><!-- markdownlint-disable-line -->
41+
<summary>Click to expand!</summary><!-- markdownlint-disable-line -->
7842

7943
### For Linux users
8044

@@ -99,6 +63,6 @@ PS> Invoke-RestMethod -Uri $SRC -OutFile $DST
9963
```
10064
</details>
10165

102-
# License
66+
## ⚖️ License
10367

10468
[Apache-2.0](LICENSE)

0 commit comments

Comments
 (0)