@aws/energy-workbench-cli
v0.0.1
Published
Workbench CLI + SDK + module library to serve as companion toolkit for OSDU on AWS.
Readme
Energy Workbench CLI
This command line interface automates development and operational tasks for OSDU open source software. The workbench combines pre-built software modules, data operations via SDK, and common operational commands into a single command line interface. OSDU Workbench (owb) reduces common operations that take days or weeks to hours or minutes.
Usage
For development
./bin/dev <your-command>$ npm install -g @aws/energy-workbench-cli
$ ewb COMMAND
running command...
$ ewb (--version)
@aws/energy-workbench-cli/0.0.1 darwin-arm64 node-v19.9.0
$ ewb --help [COMMAND]
USAGE
$ ewb COMMAND
...Commands
ewb config [ENCRYPT]ewb create module [TEMPLATE]ewb create project [TEMPLATE]ewb exportewb group add [GROUPTOADD]ewb group listewb help [COMMANDS]ewb member add GROUPNAME MEMBERNAME ROLEewb member groups MEMBERTOLISTewb member list GROUPTOLISTewb pluginsewb plugins:install PLUGIN...ewb plugins:inspect PLUGIN...ewb plugins:install PLUGIN...ewb plugins:link PLUGINewb plugins:uninstall PLUGIN...ewb plugins:uninstall PLUGIN...ewb plugins:uninstall PLUGIN...ewb plugins updateewb search kind [KIND]ewb startewb user add [USERNAME] [USERPASSWORD] [POOLID]
ewb config [ENCRYPT]
Configures credentials and saves them to local file.
USAGE
$ ewb config [ENCRYPT] [-p <value>] [-k <value>] [-s <value>]
ARGUMENTS
ENCRYPT Encrypt secret
FLAGS
-k, --format=<value> API Key
-p, --source=<value> [default: default] OSDU User Profile to Use
-s, --display=<value> API Secret
DESCRIPTION
Configures credentials and saves them to local file.
EXAMPLES
$ ewb config --profile 'example' --ApiKey 'yourKey' --ApiSecret 'abc123'See code: src/commands/config.ts
ewb create module [TEMPLATE]
Add a new module to an existing project
USAGE
$ ewb create module [TEMPLATE]
ARGUMENTS
TEMPLATE Template
DESCRIPTION
Add a new module to an existing project
EXAMPLES
$ ewb create module 'app' --template 'example' --git 'true' --cicd 'true'See code: src/commands/create/module.ts
ewb create project [TEMPLATE]
Start new application or project from a template
USAGE
$ ewb create project [TEMPLATE] [-g <value>] [-c <value>]
ARGUMENTS
TEMPLATE Template
FLAGS
-c, --cicd=<value> [default: github] Option to include cicd pipeline.
-g, --git=<value> [default: true] Option for creating git repository
DESCRIPTION
Start new application or project from a template
EXAMPLES
$ ewb create project 'app' --template 'example' --git 'true' --cicd 'true'See code: src/commands/create/project.ts
ewb export
Export credentials to local command line session.
USAGE
$ ewb export [-p <value>]
FLAGS
-p, --profile=<value> [default: default] Local configuration profile to use
DESCRIPTION
Export credentials to local command line session.
EXAMPLES
$ ewb export --profile 'example'See code: src/commands/export.ts
ewb group add [GROUPTOADD]
Adds a group
USAGE
$ ewb group add [GROUPTOADD]
ARGUMENTS
GROUPTOADD Group to add
DESCRIPTION
Adds a group
EXAMPLES
$ ewb group addSee code: src/commands/group/add.ts
ewb group list
List all groups for a specific instance.
USAGE
$ ewb group list
DESCRIPTION
List all groups for a specific instance.
EXAMPLES
$ ewb group listSee code: src/commands/group/list.ts
ewb help [COMMANDS]
Display help for ewb.
USAGE
$ ewb help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for ewb.See code: @oclif/plugin-help
ewb member add GROUPNAME MEMBERNAME ROLE
Add a member to a specific group with a defined role.
USAGE
$ ewb member add GROUPNAME MEMBERNAME ROLE
ARGUMENTS
GROUPNAME Group to add member to.
MEMBERNAME Member to add to the group.
ROLE Role to add member with.
DESCRIPTION
Add a member to a specific group with a defined role.
EXAMPLES
$ ewb member add [email protected] [email protected] OWNERSee code: src/commands/member/add.ts
ewb member groups MEMBERTOLIST
List all groups for a specific member.
USAGE
$ ewb member groups MEMBERTOLIST
ARGUMENTS
MEMBERTOLIST Member to list groups from.
DESCRIPTION
List all groups for a specific member.
EXAMPLES
$ ewb member groups [email protected]See code: src/commands/member/groups.ts
ewb member list GROUPTOLIST
List all members for a specific group.
USAGE
$ ewb member list GROUPTOLIST
ARGUMENTS
GROUPTOLIST Group to list members from.
DESCRIPTION
List all members for a specific group.
EXAMPLES
$ ewb member list [email protected]See code: src/commands/member/list.ts
ewb plugins
List installed plugins.
USAGE
$ ewb plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ewb pluginsSee code: @oclif/plugin-plugins
ewb plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ ewb plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ ewb plugins add
EXAMPLES
$ ewb plugins:install myplugin
$ ewb plugins:install https://github.com/someuser/someplugin
$ ewb plugins:install someuser/somepluginewb plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ ewb plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ ewb plugins:inspect mypluginSee code: @oclif/plugin-plugins
ewb plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ ewb plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ ewb plugins add
EXAMPLES
$ ewb plugins:install myplugin
$ ewb plugins:install https://github.com/someuser/someplugin
$ ewb plugins:install someuser/somepluginSee code: @oclif/plugin-plugins
ewb plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ ewb plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ ewb plugins:link mypluginSee code: @oclif/plugin-plugins
ewb plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ewb plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ewb plugins unlink
$ ewb plugins removeewb plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ewb plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ewb plugins unlink
$ ewb plugins removeSee code: @oclif/plugin-plugins
ewb plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ewb plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ewb plugins unlink
$ ewb plugins removeewb plugins update
Update installed plugins.
USAGE
$ ewb plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
ewb search kind [KIND]
Perform a search call using the kind key and flags for query and limit
USAGE
$ ewb search kind [KIND] [-q <value>] [--limit <value>] [--table <value>]
ARGUMENTS
KIND kind to query
FLAGS
-q, --query=<value> Specific query to run
--limit=<value> How many lines to return
--table=<value> What format to display search results
DESCRIPTION
Perform a search call using the kind key and flags for query and limit
EXAMPLES
$ ewb search kind osdu:wks:master-data--Well:1.0.0See code: src/commands/search/kind.ts
ewb start
Basic start command implements a command prompt input workflow.
USAGE
$ ewb start
DESCRIPTION
Basic start command implements a command prompt input workflow.
EXAMPLES
$ ewb startSee code: src/commands/start.ts
ewb user add [USERNAME] [USERPASSWORD] [POOLID]
Adds a user to a cognito user pool
USAGE
$ ewb user add [USERNAME] [USERPASSWORD] [POOLID]
ARGUMENTS
USERNAME User to add
USERPASSWORD Password to add
POOLID Cognito Pool ID
DESCRIPTION
Adds a user to a cognito user pool
EXAMPLES
$ ewb user addSee code: src/commands/user/add.ts
