Skip to content

Commit 970abbe

Browse files
author
Marco Franceschi
committed
chore: Updated docs
1 parent cc95962 commit 970abbe

14 files changed

Lines changed: 413 additions & 412 deletions

File tree

‎README.md‎

Lines changed: 232 additions & 159 deletions
Large diffs are not rendered by default.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
},
1616
"bugs": "https://github.com/cloudgraphdev/cli/issues",
1717
"dependencies": {
18-
"@cloudgraph/sdk": "^0.10.4",
18+
"@cloudgraph/sdk": "0.10.4",
1919
"@graphql-tools/load-files": "^6.3.2",
2020
"@graphql-tools/merge": "^8.2.0",
2121
"@oclif/command": "^1",

‎src/commands/policy/add.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import OperationBaseCommand from '../operation'
55
export default class AddPolicy extends OperationBaseCommand {
66
static description = 'Add new policy packs'
77

8-
static aliases = ['add:pp']
8+
static aliases = ['add:policy']
99

1010
static examples = [
11-
'$ cg add policy aws-cis-1.2.0',
12-
'$ cg add policy aws-cis-1.2.0@0.12.0',
11+
'$ cg policy add aws-cis-1.2.0',
12+
'$ cg policy add aws-cis-1.2.0@0.12.0',
1313
]
1414

1515
static strict = false

‎src/commands/policy/install.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ import OperationBaseCommand from '../operation'
55
export default class InstallPolicy extends OperationBaseCommand {
66
static description = 'Install policy packs based on the lock file'
77

8-
static aliases = ['install:pp']
8+
static aliases = ['install:policy']
99

10-
static examples = ['$ cg install policy']
10+
static examples = ['$ cg policy install']
1111

1212
static strict = false
1313

‎src/commands/policy/list.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export default class ListPolicy extends OperationBaseCommand {
77

88
static aliases = ['ls:policy', 'list:pp', 'ls:pp']
99

10-
static examples = ['$ cg list policy', '$ cg list policy aws']
10+
static examples = ['$ cg policy list', '$ cg policy list aws']
1111

1212
static strict = false
1313

‎src/commands/policy/remove.ts‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,18 @@ import OperationBaseCommand from '../operation'
55
export default class RemovePolicy extends OperationBaseCommand {
66
static description = 'Remove currently installed policy pack'
77

8-
static aliases = ['remove:pp', 'rm:pp', 'del:pp', 'rm:policy', 'del:policy']
8+
static aliases = [
9+
'policy:remove',
10+
'policy:rm',
11+
'del:policy',
12+
'rm:policy',
13+
'del:policy',
14+
]
915

1016
static examples = [
11-
'$ cg delete policy',
12-
'$ cg delete policy aws-cis-1.2.0',
13-
'$ cg delete policy aws-cis-1.2.0 --no-save',
17+
'$ cg policy delete',
18+
'$ cg policy delete aws-cis-1.2.0',
19+
'$ cg policy delete aws-cis-1.2.0 --no-save',
1420
]
1521

1622
static strict = false

src/commands/policy/upgrade.ts renamed to src/commands/policy/update.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ import { PluginType } from '@cloudgraph/sdk'
22

33
import OperationBaseCommand from '../operation'
44

5-
export default class UpgradePolicy extends OperationBaseCommand {
6-
static description = 'Upgrade currently installed policy packs'
5+
export default class UpdatePolicy extends OperationBaseCommand {
6+
static description = 'Update currently installed policy packs'
77

8-
static aliases = ['update:pp']
8+
static aliases = []
99

1010
static examples = [
11-
'$ cg upgrade policy',
12-
'$ cg upgrade policy aws-cis-1.2.0',
13-
'$ cg upgrade policy aws-cis-1.2.0@0.12.0',
11+
'$ cg policy update',
12+
'$ cg policy update aws-cis-1.2.0',
13+
'$ cg policy update aws-cis-1.2.0@0.12.0',
1414
]
1515

1616
static strict = false

‎src/commands/provider/add.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ import OperationBaseCommand from '../operation'
55
export default class AddProvider extends OperationBaseCommand {
66
static description = 'Add new providers'
77

8-
static aliases = ['add']
8+
static aliases = ['add:provider']
99

10-
static examples = ['$ cg add provider aws', '$ cg add provider aws@0.12.0']
10+
static examples = ['$ cg provider add aws', '$ cg provider add aws@0.12.0']
1111

1212
static strict = false
1313

‎src/commands/provider/install.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ import OperationBaseCommand from '../operation'
55
export default class InstallProvider extends OperationBaseCommand {
66
static description = 'Install providers based on the lock file'
77

8-
static aliases = ['install']
8+
static aliases = ['install:provider']
99

10-
static examples = ['$ cg install provider']
10+
static examples = ['$ cg provider install']
1111

1212
static strict = false
1313

‎src/commands/provider/list.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ import OperationBaseCommand from '../operation'
55
export default class ListProvider extends OperationBaseCommand {
66
static description = 'List currently installed providers and versions'
77

8-
static aliases = ['ls', 'list', 'ls']
8+
static aliases = ['ls:provider', 'list:provider', 'ls:provider']
99

10-
static examples = ['$ cg list provider', '$ cg list provider aws']
10+
static examples = ['$ cg provider list', '$ cg provider list aws']
1111

1212
static strict = false
1313

0 commit comments

Comments
 (0)