From 65dc16173325ed52dc32a52743df2e59eb55a872 Mon Sep 17 00:00:00 2001 From: Elamaran Shanmugam Date: Wed, 24 Jan 2024 13:29:07 -0500 Subject: [PATCH 1/3] Remove Flags --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index d5136f1..96f36be 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,6 @@ To implement this solution, you need the following prerequisites: # Usage ```sh-session -$ npm install -g aws-sleek-transformer $ aws-sleek-transformer COMMAND running command... $ aws-sleek-transformer (--version) From 0ea0dec7fb1f6cb406283f6dda6e15d96732791c Mon Sep 17 00:00:00 2001 From: Elamaran Shanmugam Date: Wed, 24 Jan 2024 13:37:02 -0500 Subject: [PATCH 2/3] Remove Flags --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 96f36be..48ec869 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,9 @@ To implement this solution, you need the following prerequisites: # Usage ```sh-session +$ git clone https://github.com/aws-samples/addons-transformer-for-amazon-eks.git +$ npm pack +$ npm install $ aws-sleek-transformer COMMAND running command... $ aws-sleek-transformer (--version) From d0b7e4a21acf836ff587af3a3e69a8ecf8f8441f Mon Sep 17 00:00:00 2001 From: Elamaran Shanmugam Date: Wed, 24 Jan 2024 14:00:05 -0500 Subject: [PATCH 3/3] Remove Flags and Fixing Documentation --- README.md | 50 ++++++++++++++++++++++++-------------------------- package.json | 15 +++++++-------- 2 files changed, 31 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 48ec869..5599f77 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -AWS Sleek Transformer CLI -========================= +Addons Transformer CLI for Amazon EKS +===================================== * [Usage](#usage) @@ -38,33 +38,31 @@ To implement this solution, you need the following prerequisites: # Usage ```sh-session -$ git clone https://github.com/aws-samples/addons-transformer-for-amazon-eks.git -$ npm pack -$ npm install -$ aws-sleek-transformer COMMAND +$ npm install -g addons-transformer-for-amazon-eks +$ addons-transformer-for-amazon-eks COMMAND running command... -$ aws-sleek-transformer (--version) -aws-sleek-transformer/0.0.1 darwin-arm64 node-v20.10.0 -$ aws-sleek-transformer --help [COMMAND] +$ addons-transformer-for-amazon-eks (--version) +addons-transformer-for-amazon-eks/0.0.1 darwin-arm64 node-v20.8.0 +$ addons-transformer-for-amazon-eks --help [COMMAND] USAGE - $ aws-sleek-transformer COMMAND + $ addons-transformer-for-amazon-eks COMMAND ... ``` # Commands -* [`aws-sleek-transformer configure`](#aws-sleek-transformer-configure) -* [`aws-sleek-transformer submit`](#aws-sleek-transformer-submit) -* [`aws-sleek-transformer validate`](#aws-sleek-transformer-validate) +* [`addons-transformer-for-amazon-eks configure`](#addons-transformer-for-amazon-eks-configure) +* [`addons-transformer-for-amazon-eks submit`](#addons-transformer-for-amazon-eks-submit) +* [`addons-transformer-for-amazon-eks validate`](#addons-transformer-for-amazon-eks-validate) -## `aws-sleek-transformer configure` +## `addons-transformer-for-amazon-eks configure` Sets up the Sleek CLI to work with a given helm chart ``` USAGE - $ aws-sleek-transformer configure [--addonName ] [--addonVersion ] [--helmUrl ] - [--marketplaceId ] [--namespace ] [--region ] + $ addons-transformer-for-amazon-eks configure [--addonName ] [--addonVersion ] [--helmUrl + ] [--marketplaceId ] [--namespace ] [--region ] FLAGS --addonName= Name of the addon @@ -103,18 +101,18 @@ DESCRIPTION EXAMPLES - $ aws-sleek-transformer configure + $ addons-transformer-for-amazon-eks configure ``` -_See code: [src/commands/configure.ts](https://github.com/elaramas/aws-sleek-transformer/blob/v0.0.1/src/commands/configure.ts)_ +_See code: [src/commands/configure.ts](https://github.com/aws-samples/addons-transformer-for-amazon-eks/blob/v0.0.1/src/commands/configure.ts)_ -## `aws-sleek-transformer submit` +## `addons-transformer-for-amazon-eks submit` Uses the pre-existing configurations to submit the addon to the AWS marketplace ``` USAGE - $ aws-sleek-transformer submit [--addonName ] [--addonVersion ] + $ addons-transformer-for-amazon-eks submit [--addonName ] [--addonVersion ] FLAGS --addonName= Name of the addon to submit @@ -141,18 +139,18 @@ DESCRIPTION EXAMPLES - $ aws-sleek-transformer submit + $ addons-transformer-for-amazon-eks submit ``` -_See code: [src/commands/submit.ts](https://github.com/elaramas/aws-sleek-transformer/blob/v0.0.1/src/commands/submit.ts)_ +_See code: [src/commands/submit.ts](https://github.com/aws-samples/addons-transformer-for-amazon-eks/blob/v0.0.1/src/commands/submit.ts)_ -## `aws-sleek-transformer validate` +## `addons-transformer-for-amazon-eks validate` Validates a given addon from the configuration provided through the 'configure' command ``` USAGE - $ aws-sleek-transformer validate [--addonName ] [--addonVersion ] + $ addons-transformer-for-amazon-eks validate [--addonName ] [--addonVersion ] FLAGS --addonName= Name of the addon to validate @@ -178,8 +176,8 @@ DESCRIPTION EXAMPLES - $ aws-sleek-transformer validate + $ addons-transformer-for-amazon-eks validate ``` -_See code: [src/commands/validate.ts](https://github.com/elaramas/aws-sleek-transformer/blob/v0.0.1/src/commands/validate.ts)_ +_See code: [src/commands/validate.ts](https://github.com/aws-samples/addons-transformer-for-amazon-eks/blob/v0.0.1/src/commands/validate.ts)_ diff --git a/package.json b/package.json index a25ce73..db4bef1 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "author": "Shardul Vaidya @5herlocked", + "author": "Elamaran Shanmugam @elamaras", "bin": "./bin/run.js", "dependencies": { "@aws-sdk/client-sts": "^3.462.0", @@ -7,7 +7,6 @@ "@inquirer/select": "^1.3.1", "@oclif/core": "^3", "@oclif/plugin-help": "^5", - "aws-sleek-transformer": "file:aws-sleek-transformer-0.0.1.tgz", "oclif": "^4.0.3", "shx": "^0.3.4" }, @@ -37,13 +36,13 @@ "/dist", "/oclif.manifest.json" ], - "homepage": "https://github.com/elaramas/aws-sleek-transformer", + "homepage": "https://github.com/aws-samples/addons-transformer-for-amazon-eks.git", "main": "", "license": "MIT", - "name": "aws-sleek-transformer", + "name": "addons-transformer-for-amazon-eks", "oclif": { - "bin": "aws-sleek-transformer", - "dirname": "aws-sleek-transformer", + "bin": "addons-transformer-for-amazon-eks", + "dirname": "addons-transformer-for-amazon-eks", "commands": "./dist/commands", "topicSeparator": " ", "macos": { @@ -61,7 +60,7 @@ } } }, - "repository": "elaramas/aws-sleek-transformer", + "repository": "aws-samples/addons-transformer-for-amazon-eks", "scripts": { "build": "shx rm -rf dist && tsc -b", "lint": "eslint . --ext .ts", @@ -72,7 +71,7 @@ "version": "oclif readme && git add README.md" }, "version": "0.0.1", - "bugs": "https://github.com/elaramas/aws-sleek-transformer/issues", + "bugs": "https://github.com/aws-samples/addons-transformer-for-amazon-eks/issues", "keywords": [ "oclif" ],