Skip to content

Commit

Permalink
refactor README
Browse files Browse the repository at this point in the history
  • Loading branch information
chinmaysomani07 committed Mar 5, 2023
1 parent 59eee16 commit 7d16346
Show file tree
Hide file tree
Showing 18 changed files with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions README.md
Expand Up @@ -6,7 +6,7 @@

![](./assets/cloudlensdemo.gif)

Your One-Stop Terminal Solution for Seamless AWS Service Management and Monitoring! With its intuitive UI and advanced features, it empowers you to effortlessly navigate, observe, and optimize your AWS environment, giving you more time to focus on your core business goals. Whether you're a seasoned cloud expert or just getting started, cloudlens will elevate your AWS experience and take your service management to new heights.
Cloudlens provides a terminal UI for AWS Service Management and Monitoring! With its easy to use UI and advanced features, you can easily navigate, observe, and optimize your AWS environment. Whether you're a cloud expert or just getting started, cloudlens will elevate your AWS experience and take your service management to new heights.

## Installation

Expand All @@ -24,9 +24,10 @@ Cloudlens is available on Linux and macOS.
1. Clone the repo
2. Build and run the executable

To Run:
```shell
make run
```
make run
```

## Usage

Expand All @@ -45,12 +46,23 @@ cloudlens help

Our terminal application supports various features, allowing users to view EC2 instances, S3 buckets, EBS volumes, VPCs, SQS queues, Lambda functions, subnets, security groups, and IAM roles, making their work faster and more efficient.

## Screenshots

1. EC2
<img src="assets/ec2.png"/>
1. EC2 Details
<img src="assets/ec2Details.png"/>

2. S3
<img src="assets/S3.png"/>
2. S3 Details
<img src="assets/S3Details.png"/>

## Documentation

Please refer to our [Cloudlens documentation](https://one2n.gitbook.io/docs/) to know more.



## Key Bindings

Cloudlens uses k9s like shortcuts for navigation. Listed below are few of the shortcuts:
Expand All @@ -60,20 +72,7 @@ Cloudlens uses k9s like shortcuts for navigation. Listed below are few of the sh
| Show active keyboard mnemonics and help | `?` | | |
| To bail out of cloudlens | `:q`, `ctrl-c` | |
| Bails out of view/command/filter mode | `<esc>` | |
| To view and switch to another AWS Service | `:`ctx⏎ | |


## Screenshots

1. EC2
<img src="assets/ec2.png"/>
1. EC2 Details
<img src="assets/Ec2Json.png"/>

2. S3
<img src="assets/s3.png"/>
2. S3 Details
<img src="assets/s3Details.png"/>
| To view and switch to another AWS Service | `:`S3/EC2/VPC⏎ | |

## Note
**Cloudlens reads your ~/.aws/config file, but it does not store or send your access and secret key anywhere. The access and secret key is used only to securely connect to AWS API via AWS SDK.**
Expand Down
Binary file removed assets/Ec2Json.png
Binary file not shown.
Binary file modified assets/ec2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/ec2Details.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/iamg-details.png
Binary file not shown.
Binary file removed assets/iamg.png
Binary file not shown.
Binary file removed assets/iamr-details.png
Binary file not shown.
Binary file removed assets/iamr.png
Binary file not shown.
Binary file removed assets/iamu-details.png
Binary file not shown.
Binary file removed assets/iamu.png
Binary file not shown.
Binary file removed assets/lambda.png
Binary file not shown.
Binary file removed assets/localstack.jpeg
Binary file not shown.
Binary file modified assets/s3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/s3Details.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/sqs-details.png
Binary file not shown.
Binary file removed assets/sqs.png
Binary file not shown.
Binary file removed assets/vpc-details.png
Binary file not shown.
Binary file removed assets/vpc.png
Binary file not shown.

0 comments on commit 7d16346

Please sign in to comment.