0.0.6 • Published 1 year ago

mango-platform-cli v0.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Mango Platform CLI

Build

npm run build

Running

./bin/run

Publish

npm run build npm version npm publish

Generate Mango Api Server JS Client

  • Run the Mango Api Server Java Application on port 7878 npm run generate-client will create the Mango Api Server JS Client at the location src\test\client which allows you to view the JS Client Model and Services.
  • Copy the Mango Api Server JS Client from src\test\client to its final resting place at src\client

Supplying Commands

mango-cli get Application mango-cli create Application --file application.yaml

Step 1 - Initialize Mango Platform API Server & Mango Platform CLI

mango-cli setup

Step 2 - Register, Login

mango-cli register mango-cli login

Step 3 - Set Credentials for Contexts

mango-cli configure

Quick setup for Development

mango-cli configure --simple

Supplying Flags

./bin/run create Application --file application.yaml

Create Context

./bin/run create Context --file sample_yamls/context.yaml

Create Application Shell

./bin/run create ApplicationShell -f sample_yamls/application_shell.yaml

TODO

  • cli create application_shell command with code generation for angular using a basic foundation that is the default foundation in mango that allows an application shell to load a single application.
  • cli create application_shell command with code generation for angular using a foundation_id that gets the foundation template
  • enable mango configure to call setup Mango Api Server Java Application

npm library troubleshooting

Global libraries You can run npm list -g to see which global libraries are installed and where they're located. Use npm list -g | head -1 for truncated output showing just the path. If you want to display only main packages not its sub-packages which installs along with it - you can use - npm list --depth=0 which will show all packages and for getting only globally installed packages, just add -g i.e. npm list -g --depth=0.

On Unix systems they are normally placed in /usr/local/lib/node or /usr/local/lib/node_modules when installed globally. If you set the NODE_PATH environment variable to this path, the modules can be found by node.

Windows XP - %USERPROFILE%\AppData\npm\node_modules Windows 7, 8 and 10 - %USERPROFILE%\AppData\Roaming\npm\node_modules

Non-global libraries Non-global libraries are installed the node_modules sub folder in the folder you are currently in.

You can run npm list to see the installed non-global libraries for your current location.

When installing use -g option to install globally npm install -g pm2 - pm2 will be installed globally. It will then typically be found in /usr/local/lib/node_modules (Use npm root -g to check where.)

npm install pm2 - pm2 will be installed locally. It will then typically be found in the local directory in /node_modules

Usage

$ npm install -g mango-platform-cli
$ mango-cli COMMAND
running command...
$ mango-cli (--version)
mango-platform-cli/0.0.6 darwin-x64 node-v16.13.0
$ mango-cli --help [COMMAND]
USAGE
  $ mango-cli COMMAND
...

Commands

mango-cli configure

Configure Mango Platform Configure

USAGE
  $ mango-cli configure [-d] [-s]

FLAGS
  -d, --default_data  Insert default development Context called "development" to Mango CLI database.
  -s, --simple

DESCRIPTION
  Configure Mango Platform Configure

EXAMPLES
  $ mango-cli configure

See code: dist/commands/configure.ts

mango-cli create [KIND]

Create a resource from a file or from stdin.

USAGE
  $ mango-cli create [KIND] [-f <value>]

ARGUMENTS
  KIND  Kind for resource being created.

FLAGS
  -f, --file=<value>  file to read

DESCRIPTION
  Create a resource from a file or from stdin.

EXAMPLES
  $ mango-cli create -f path/file.yaml

See code: dist/commands/create.ts

mango-cli get [KIND]

Display one or many resources

USAGE
  $ mango-cli get [KIND] [--json] [-n <value>] [-f] [--columns <value> | -x] [--sort <value>] [--filter
    <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

ARGUMENTS
  KIND  get

FLAGS
  -f, --force
  -n, --name=<value>  kind to print
  -x, --extended      show extra columns
  --columns=<value>   only show provided columns (comma-separated)
  --csv               output is csv format [alias: --output=csv]
  --filter=<value>    filter property by partial string matching, ex: name=foo
  --no-header         hide table header from output
  --no-truncate       do not truncate output to fit screen
  --output=<option>   output in a more machine friendly format
                      <options: csv|json|yaml>
  --sort=<value>      property to sort by (prepend '-' for descending)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Display one or many resources

EXAMPLES
  $ mango-cli get applications

See code: dist/commands/get.ts

mango-cli help [COMMANDS]

Display help for mango-cli.

USAGE
  $ mango-cli 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 mango-cli.

See code: @oclif/plugin-help

mango-cli login [FILE]

Mango Platform User Login

USAGE
  $ mango-cli login [FILE] [-n <value>] [-f]

ARGUMENTS
  FILE  file to read

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  Mango Platform User Login

EXAMPLES
  $ mango-cli login

See code: dist/commands/login.ts

mango-cli plugins

List installed plugins.

USAGE
  $ mango-cli plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ mango-cli plugins

See code: @oclif/plugin-plugins

mango-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ mango-cli 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
  $ mango-cli plugins add

EXAMPLES
  $ mango-cli plugins:install myplugin 

  $ mango-cli plugins:install https://github.com/someuser/someplugin

  $ mango-cli plugins:install someuser/someplugin

mango-cli plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ mango-cli 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
  $ mango-cli plugins:inspect myplugin

mango-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ mango-cli 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
  $ mango-cli plugins add

EXAMPLES
  $ mango-cli plugins:install myplugin 

  $ mango-cli plugins:install https://github.com/someuser/someplugin

  $ mango-cli plugins:install someuser/someplugin

mango-cli plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ mango-cli 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
  $ mango-cli plugins:link myplugin

mango-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ mango-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mango-cli plugins unlink
  $ mango-cli plugins remove

mango-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ mango-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mango-cli plugins unlink
  $ mango-cli plugins remove

mango-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ mango-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mango-cli plugins unlink
  $ mango-cli plugins remove

mango-cli plugins update

Update installed plugins.

USAGE
  $ mango-cli plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

mango-cli register

Mango Platform User Registration

USAGE
  $ mango-cli register

DESCRIPTION
  Mango Platform User Registration

EXAMPLES
  $ mango-cli register

See code: dist/commands/register.ts

mango-cli setup

describe the command here

USAGE
  $ mango-cli setup [-r]

FLAGS
  -r, --recreate_database  Recreate Mango CLI database. VOLATILE operation. This will delete your local Mango Platform
                           CLI configuration.

DESCRIPTION
  describe the command here

EXAMPLES
  $ mango-cli setup

See code: dist/commands/setup.ts