-
Notifications
You must be signed in to change notification settings - Fork 2
/
usage.js
59 lines (55 loc) · 2.39 KB
/
usage.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/*
* Copyright 2018 IBM Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Usage model for the composer plugin
*
*/
module.exports = {
composer: {
breadcrumb: 'Composer',
title: 'Create and invoke complex applications',
header: 'These commands will help you work with Composer applications.',
example: 'composer <command>',
commandPrefix: 'composer',
available: [{ command: 'app', docs: 'create and invoke compositions', dir: true },
{ command: 'session', docs: 'inspect the results of composition activations', dir: true },
{ command: 'config', docs: 'print the details of your configuration' }],
related: ['help', 'wsk']
},
app: {
title: 'CRUD Operations',
header: 'These commands will help you create and invoke Composer applications.',
example: 'wsk app <command>',
commandPrefix: 'wsk app',
available: [{ command: 'create', docs: 'create a new composition' },
{ command: 'get', docs: 'get the details of a given composition' },
{ command: 'invoke', docs: 'invoke a given composition' },
{ command: 'preview', docs: 'visualize a composition, without deploying it' },
{ command: 'list', docs: 'list all compositions' }],
parents: ['composer'],
related: ['composer session']
},
session: {
title: 'Inspecting Sessions',
header: 'These commands will help you inspect the activation results of Composer applications.',
example: 'wsk session <command>',
commandPrefix: 'session',
available: [{ command: 'get', docs: 'get the details of a given Composer activation' },
{ command: 'list', docs: 'list recent Composer activations' }],
parents: ['composer'],
related: ['composer app']
}
}