diff --git a/README.md b/README.md index 7dd8347..a5ac481 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ Cloudlens

-## Cloudlens - k9s like CLI for AWS. +## Cloudlens - k9s like CLI for AWS and GCP. ![](./assets/cloudlensdemo.gif) -AWS Console in your terminal! well, almost. Explore AWS services like EC2, S3, IAM, VPC, etc. from your terminal. If you like k9s for Kubernetes, you'll love cloudlens. +AWS and GCP Console in your terminal! well, almost. Explore AWS and GCP services like EC2, S3, IAM, VPC, VM, Storage etc. from your terminal. If you like k9s for Kubernetes, you'll love cloudlens. ## Installation @@ -38,12 +38,24 @@ AWS Console in your terminal! well, almost. Explore AWS services like EC2, S3, I ## Usage -For the simple usage, just run the command without any options. +### Using UI +- For the simple usage, just run the `cloudlens` command without any options. +- This will open an UI to select cloud platform. +- Note: when selecting `GCP` as cloud, make sure to set `GOOGLE_APPLICATION_CREDENTIALS` env variable to gcp-credentials file's path. ```shell cloudlens ``` - +### Using Sub-Commands +- Alternative to UI, you could also use sub-commands and flags to select cloud platform. +- To select AWS. +```shell +cloudlens aws +``` +- To select GCP. +```shell +cloudlens gcp --cf="path/to/gcp-credentials.json" +``` For knowing all the options available, use: ```shell cloudlens help @@ -65,10 +77,15 @@ cloudlens aws --localstack --port 4000 ## Features -Cloudlens supports viewing EC2 instances, S3 buckets, EBS volumes, VPCs, SQS queues, Lambda functions, Subnets, Security Groups, and IAM roles. Read the [cloudlens documentation](https://one2n.gitbook.io/docs/) to know more. +### AWS +For AWS Cloudlens supports viewing EC2 instances, S3 buckets, EBS volumes, VPCs, SQS queues, Lambda functions, Subnets, Security Groups, and IAM roles. +### GCP +For GCP Cloudlens supports viewing VM instances, Storage buckets, Disks, Snapshots, Images. -## Screenshots + Read the [cloudlens documentation](https://one2n.gitbook.io/docs/) to know more. +## Screenshots +### AWS 1. EC2 1. EC2 Details @@ -78,6 +95,16 @@ Cloudlens supports viewing EC2 instances, S3 buckets, EBS volumes, VPCs, SQS que 2. S3 Details +### GCP +1. VM + +1. VM Details + + +2. Storage + +2. Storage Details + ## Documentation @@ -94,6 +121,7 @@ Cloudlens uses k9s like shortcuts for navigation. Listed below are few of the sh | To bail out of cloudlens | :q , ctrl-c | | Bails out of view/command/filter mode | esc | | To view and switch to another AWS Service | :S3/EC2/VPC⏎ | +| To view and switch to another GCP Service | :storage/vm/disk⏎ | ## 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.** diff --git a/assets/gcp_storage.png b/assets/gcp_storage.png new file mode 100644 index 0000000..9df634d Binary files /dev/null and b/assets/gcp_storage.png differ diff --git a/assets/gcp_storage_details.png b/assets/gcp_storage_details.png new file mode 100644 index 0000000..be072d5 Binary files /dev/null and b/assets/gcp_storage_details.png differ diff --git a/assets/gcp_vm.png b/assets/gcp_vm.png new file mode 100644 index 0000000..9cc7b43 Binary files /dev/null and b/assets/gcp_vm.png differ diff --git a/assets/gcp_vm_details.png b/assets/gcp_vm_details.png new file mode 100644 index 0000000..da5e886 Binary files /dev/null and b/assets/gcp_vm_details.png differ diff --git a/docs/.gitbook/assets/gcp_disks.png b/docs/.gitbook/assets/gcp_disks.png new file mode 100644 index 0000000..3de36cf Binary files /dev/null and b/docs/.gitbook/assets/gcp_disks.png differ diff --git a/docs/.gitbook/assets/gcp_disks_details.png b/docs/.gitbook/assets/gcp_disks_details.png new file mode 100644 index 0000000..6cea219 Binary files /dev/null and b/docs/.gitbook/assets/gcp_disks_details.png differ diff --git a/docs/.gitbook/assets/gcp_image_details.png b/docs/.gitbook/assets/gcp_image_details.png new file mode 100644 index 0000000..82148f8 Binary files /dev/null and b/docs/.gitbook/assets/gcp_image_details.png differ diff --git a/docs/.gitbook/assets/gcp_snapshot_details.png b/docs/.gitbook/assets/gcp_snapshot_details.png new file mode 100644 index 0000000..4e9a8ff Binary files /dev/null and b/docs/.gitbook/assets/gcp_snapshot_details.png differ diff --git a/docs/.gitbook/assets/gcp_storage.png b/docs/.gitbook/assets/gcp_storage.png new file mode 100644 index 0000000..9df634d Binary files /dev/null and b/docs/.gitbook/assets/gcp_storage.png differ diff --git a/docs/.gitbook/assets/gcp_storage_details.png b/docs/.gitbook/assets/gcp_storage_details.png new file mode 100644 index 0000000..be072d5 Binary files /dev/null and b/docs/.gitbook/assets/gcp_storage_details.png differ diff --git a/docs/.gitbook/assets/gcp_vm.png b/docs/.gitbook/assets/gcp_vm.png new file mode 100644 index 0000000..9cc7b43 Binary files /dev/null and b/docs/.gitbook/assets/gcp_vm.png differ diff --git a/docs/.gitbook/assets/gcp_vm_details.png b/docs/.gitbook/assets/gcp_vm_details.png new file mode 100644 index 0000000..da5e886 Binary files /dev/null and b/docs/.gitbook/assets/gcp_vm_details.png differ diff --git a/docs/.gitbook/assets/gcp_vm_images.png b/docs/.gitbook/assets/gcp_vm_images.png new file mode 100644 index 0000000..a0eebbd Binary files /dev/null and b/docs/.gitbook/assets/gcp_vm_images.png differ diff --git a/docs/.gitbook/assets/gcp_vm_snapshots.png b/docs/.gitbook/assets/gcp_vm_snapshots.png new file mode 100644 index 0000000..e9ff14f Binary files /dev/null and b/docs/.gitbook/assets/gcp_vm_snapshots.png differ diff --git a/docs/README.md b/docs/README.md index 8ad9d76..efaa30c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,5 @@ --- -description: k9s like CLI for AWS +description: k9s like CLI for AWS and GCP --- # 👋 Cloudlens @@ -8,7 +8,7 @@ description: k9s like CLI for AWS ## Terminal-ate Your Cloud Worries! -AWS Console in your terminal! well, almost. Explore AWS services like EC2, S3, IAM, VPC, etc. from your terminal. If you like k9s for Kubernetes, you'll love cloudlens. +AWS and GCP Console in your terminal! well, almost. Explore AWS and GCP services like EC2, S3, IAM, VPC, VM, Storage etc. from your terminal. If you like k9s for Kubernetes, you'll love cloudlens. ### Got 2 minutes? Check out a video overview of cloudlens: @@ -36,7 +36,7 @@ cloudlens -### Features +### AWS Features | Services | Description | Alias | | ----------------------------------- | --------------------------------------------------------------------- | ------- | @@ -53,6 +53,16 @@ cloudlens | [SQS](./#sqs) | view a list of all SQS queues | `sqs` | | [Lambda](./#lambda) | view a list of all Lambda functions | `lamda` | +### GCP Features + +| Services | Description | Alias | +| ----------------------------------- | --------------------------------------------------------------------- | ------- | +| [Storage](./#storage) | View all storage buckets and their contents | `storage` | +| [VM](./#vm) | view all instances and their associated metadata, including JSON data | `vm` | +| [VM Snapshot](./#vm-snapshot) | view a list of all VM snapshots | `vm:S` | +| [VM Image](./#vm-image) | See a list of all VM images | `vm:I` | +| [Disk](./#disk) | View all available disks | `disk` | + ### Prompt To view the input prompt, press the : key. From there, you can try different commands to access and view various services.You can use the tab key or the right arrow key for autocomplete to make entering commands faster and easier. @@ -77,6 +87,8 @@ You can switch between the dropdown options using the tab button.
Dropdowns

Dropdowns

+## AWS Resources + ### S3 To view the S3 page, use the command `s3` in your prompt. Pressing enter will display all the available buckets, folders, and files. You can use the escape key to go back to the previous page.. Additionally, you can download a CSV file using the `z` command. @@ -170,3 +182,45 @@ To view SQS queues, enter `sqs` in the comman View all your Lambda functions easily by entering 'lambda' command in your terminal prompt.
+ +## GCP Resources + +### Storage + +To view the Storage buckets page, use the command `storage` in your prompt. Pressing enter will display all the available buckets, folders, and files. You can use the escape key to go back to the previous page.. Additionally, you can download a CSV file using the `z` command. + +
S3 Page

Storage Page

+ +
Storage Details Page

Storage Details Page

+ +### VM + +To view the VM page, enter the command `vm` in your prompt. Pressing enter will display all available instances. To view specific details about an instance, select it and press enter to display a JSON with the VM information. You can use the escape key to navigate back to the previous page. Additionally, you can download a CSV file by using the `z` command. + +
VM Page

VM Page

+ +
VM Details Page

VM Details Page

+ +### VM Snapshot + +To access the VM snapshots page, enter `vm:S` in your prompt and press Enter. This will display a list of all available snapshots. Select a snapshot to view its details, then press Enter again. To return to the previous page, press the Escape key. + +
VM Snapshot Page

VM Snapshot Page

+ +
VM Snapshot Details Page

VM Snapshot Details Page

+ +### VM Image + +To access the VM image page, enter `vm:I` in your prompt and press Enter. This will display a list of all available images. Select an image to view its details, then press Enter again. To return to the previous page, press the Escape key. + +
VM Image Page

VM Image Page

+ +
VM Image Details Page

VM Image Details Page

+ +### Disk + +To view Disks, enter `disk` in the command prompt and press Enter to show a list of disks. Select a disk and press Enter to view its details. To return to the previous page, press the Escape key. + +
Disk Page

Disk Page

+ +
Disk Details Page

Disk Details Page