Skip to content

Commit

Permalink
- update help page
Browse files Browse the repository at this point in the history
- add feature to readme
- Add documentation link
  • Loading branch information
aanamshaikh committed Feb 23, 2023
1 parent 84a69ef commit 4c9dce5
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 29 deletions.
44 changes: 16 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ Your One-Stop Terminal Solution for Seamless AWS Service Management and Monitori

**Since cloudlens is in readonly mode, we recommend you create an access and secret key that only has readonly permissions to the AWS services.**

## Features

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.

## Documentation

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

## We appreciate [localstack's](https://localstack.cloud/) assistance with the development

Expand All @@ -29,6 +36,15 @@ Your One-Stop Terminal Solution for Seamless AWS Service Management and Monitori
```shell
make run
```
## Installation

Cloudlens is available on Linux and macOS.

* Via [Homebrew](https://brew.sh/) for macOS or Linux

```shell
brew install one2nc/cloudlens/cloudlens
```

## Key Bindings

Expand All @@ -54,34 +70,6 @@ Cloudlens uses aliases to navigate most AWS Services.
2. S3 Details
<img src="assets/s3Details.png"/>

3. IAM:G
<img src="assets/iamg.png"/>
3. IAM:G Details
<img src="assets/iamg-details.png"/>

4. IAM:U
<img src="assets/iamu.png"/>
4. IAM:U Details
<img src="assets/iamu-details.png"/>

5. IAM:R
<img src="assets/iamr.png"/>
5. IAM:R Details
<img src="assets/iamr-details.png"/>

6. SQS
<img src="assets/sqs.png"/>
6. SQS Details:
<img src="assets/sqs-details.png"/>

7. Lambda:
<img src="assets/lambda.png"/>

8. VPC:
<img src="assets/vpc.png"/>
8. VPC Details:
<img src="assets/vpc-details.png"/>


## Acknowledgements

Expand Down
2 changes: 1 addition & 1 deletion internal/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ var config Config
func GetSession(profile, region string) (*session.Session, error) {
sess, err := session.NewSessionWithOptions(session.Options{Config: aws.Config{
//TODO: remove hardcoded enpoint
Endpoint: aws.String(localstackEndpoint),
// Endpoint: aws.String(localstackEndpoint),
Region: aws.String(region),
S3ForcePathStyle: aws.Bool(true),
},
Expand Down
20 changes: 20 additions & 0 deletions internal/view/help.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,14 @@ func (h *Help) showServices() model.MenuHints {
Mnemonic: "ec2",
Description: "View Ec2",
},
{
Mnemonic: "ec2:i",
Description: "View EC2 snapshots",
},
{
Mnemonic: "ec2:s",
Description: "View EC2 images",
},
{
Mnemonic: "vpc",
Description: "View VPC",
Expand All @@ -113,6 +121,18 @@ func (h *Help) showServices() model.MenuHints {
Mnemonic: "sg",
Description: "View Security Group",
},
{
Mnemonic: "ebs",
Description: "View EBS volumes",
},
{
Mnemonic: "sqs",
Description: "View sqs queues",
},
{
Mnemonic: "lambda",
Description: "View Lamda functions",
},
}
}

Expand Down

0 comments on commit 4c9dce5

Please sign in to comment.