chore: Updated docs for plugins commands

Author: Marco Franceschi

README.md

@@ -5,9 +5,11 @@ import OperationBaseCommand from '../operation'
 export default class AddPolicy extends OperationBaseCommand {
   static description = 'Add new policy packs'
 
+  static aliases = ['add:pp']
+
   static examples = [
-    '$ cg policy add aws-cis-1.2.0',
-    '$ cg policy add aws-cis-1.2.0@0.12.0',
+    '$ cg add policy aws-cis-1.2.0',
+    '$ cg add policy aws-cis-1.2.0@0.12.0',
   ]
 
   static strict = false

src/commands/add/policy.ts

@@ -5,9 +5,9 @@ import OperationBaseCommand from '../operation'
 export default class AddProvider extends OperationBaseCommand {
   static description = 'Add new providers'
 
-  static aliases = ['add']
+  static aliases = ['add:p']
 
-  static examples = ['$ cg provider add aws', '$ cg provider add aws@0.12.0']
+  static examples = ['$ cg add provider aws', '$ cg add provider aws@0.12.0']
 
   static strict = false
 

src/commands/add/provider.ts

@@ -5,7 +5,9 @@ import OperationBaseCommand from '../operation'
 export default class InstallPolicy extends OperationBaseCommand {
   static description = 'Install policy packs based on the lock file'
 
-  static examples = ['$ cg policy install']
+  static aliases = ['install:pp']
+
+  static examples = ['$ cg install policy']
 
   static strict = false
 

src/commands/install/policy.ts

@@ -5,9 +5,9 @@ import OperationBaseCommand from '../operation'
 export default class InstallProvider extends OperationBaseCommand {
   static description = 'Install providers based on the lock file'
 
-  static aliases = ['install']
+  static aliases = ['install:p']
 
-  static examples = ['$ cg provider install']
+  static examples = ['$ cg install provider']
 
   static strict = false
 

src/commands/install/provider.ts

@@ -5,7 +5,9 @@ import OperationBaseCommand from '../operation'
 export default class ListPolicy extends OperationBaseCommand {
   static description = 'List currently installed policy packs and versions'
 
-  static examples = ['$ cg policy list', '$ cg policy list aws']
+  static aliases = ['ls:policy', 'list:pp', 'ls:pp']
+
+  static examples = ['$ cg list policy', '$ cg list policy aws']
 
   static strict = false
 

src/commands/list/policy.ts

@@ -5,9 +5,9 @@ import OperationBaseCommand from '../operation'
 export default class ListProvider extends OperationBaseCommand {
   static description = 'List currently installed providers and versions'
 
-  static aliases = ['provider:ls', 'list', 'ls']
+  static aliases = ['ls:provider', 'list:p', 'ls:p']
 
-  static examples = ['$ cg provider list', '$ cg provider list aws']
+  static examples = ['$ cg list provider', '$ cg list provider aws']
 
   static strict = false
 

src/commands/list/provider.ts

@@ -218,7 +218,7 @@ export default abstract class OperationBaseCommand extends Command {
     }
     const pluginsToList =
       allPlugins.length >= 1
-        ? pickBy(lockFile, (_, key) => {
+        ? pickBy(lockFile?.[type], (_, key) => {
             return allPlugins.includes(key)
           })
         : lockFile?.[type] || {}

src/commands/operation.ts

@@ -2,13 +2,15 @@ import { PluginType } from '@cloudgraph/sdk'
 
 import OperationBaseCommand from '../operation'
 
-export default class Remove extends OperationBaseCommand {
+export default class RemovePolicy extends OperationBaseCommand {
   static description = 'Remove currently installed policy pack'
 
+  static aliases = ['remove:pp', 'rm:pp', 'del:pp', 'rm:policy', 'del:policy']
+
   static examples = [
-    '$ cg policy delete',
-    '$ cg policy delete aws-cis-1.2.0',
-    '$ cg policy delete aws-cis-1.2.0 --no-save',
+    '$ cg delete policy',
+    '$ cg delete policy aws-cis-1.2.0',
+    '$ cg delete policy aws-cis-1.2.0 --no-save',
   ]
 
   static strict = false

src/commands/remove/policy.ts

@@ -5,12 +5,12 @@ import OperationBaseCommand from '../operation'
 export default class RemoveProvider extends OperationBaseCommand {
   static description = 'Remove currently installed provider'
 
-  static aliases = ['remove', 'rm', 'del', 'provider:rm', 'provider:del']
+  static aliases = ['remove:p', 'rm:p', 'del:p', 'rm:provider', 'del:provider']
 
   static examples = [
-    '$ cg provider delete',
-    '$ cg provider delete aws',
-    '$ cg provider delete aws --no-save',
+    '$ cg delete provider',
+    '$ cg delete provider aws',
+    '$ cg delete provider aws --no-save',
   ]
 
   static strict = false