@veecode-platform/safira-cli

safira-cli ========== [![Publish Safira](https://github.com/veecode-platform/safira-cli/actions/workflows/master_build_publish.yml/badge.svg)](https://github.com/veecode-platform/support) safira-cli. [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/@veecode-platform/safira-cli.svg)](https://www.npmjs.com/package/@veecode-platform/safira-cli)  [![Downloads/week](https://img.shields.io/npm/dw/@veecode-platform/safira-cli.svg)](https://www.npmjs.com/package/@veecode-platform/safira-cli) [![License](https://img.shields.io/npm/l/@veecode-platform/safira-cli.svg)](https://github.com/veecode-platform/safira-cli/blob/master/package.json)  * [Requiments](#requiments) * [Usage](#usage) * [Commands](#commands)   # Requiments Before install safira-cli, check if you have installed the following dependencies: - [java11+](https://www.java.com/pt-BR/download/manual.jsp) - [python v3.6+](https://www.python.org/downloads/) - [nodejs14+](https://nodejs.org/en/download/) - [make](https://www.gnu.org/software/make/) - [cmake](https://cmake.org/download/) - [node_gyp](https://www.npmjs.com/package/node-gyp) - [g++](http://www.qnx.com/developers/docs/6.5.0SP1.update/com.qnx.doc.neutrino_utilities/g/gxx.html) - [jq](https://stedolan.github.io/jq/download/) - [curl](https://curl.se/download.html)   # Usage  ```sh-session $ npm install -g @veecode-platform/safira-cli $ safira-cli COMMAND running command... $ safira-cli (--version) @veecode-platform/safira-cli/0.11.5 linux-x64 node-v16.16.0 $ safira-cli --help [COMMAND] USAGE $ safira-cli COMMAND ... ```  # Commands  * [`safira-cli autocomplete [SHELL]`](#safira-cli-autocomplete-shell) * [`safira-cli bitbucket credential remove`](#safira-cli-bitbucket-credential-remove) * [`safira-cli bitbucket credential set`](#safira-cli-bitbucket-credential-set) * [`safira-cli commands`](#safira-cli-commands) * [`safira-cli devportal install`](#safira-cli-devportal-install) * [`safira-cli devportal remove`](#safira-cli-devportal-remove) * [`safira-cli devportal stack install`](#safira-cli-devportal-stack-install) * [`safira-cli devportal stack remove`](#safira-cli-devportal-stack-remove) * [`safira-cli doctor`](#safira-cli-doctor) * [`safira-cli github credential remove`](#safira-cli-github-credential-remove) * [`safira-cli github credential set`](#safira-cli-github-credential-set) * [`safira-cli gitlab credential remove`](#safira-cli-gitlab-credential-remove) * [`safira-cli gitlab credential set`](#safira-cli-gitlab-credential-set) * [`safira-cli help [COMMAND]`](#safira-cli-help-command) * [`safira-cli insomnia export`](#safira-cli-insomnia-export) * [`safira-cli insomnia test`](#safira-cli-insomnia-test) * [`safira-cli openapi validate [FILE-PATH]`](#safira-cli-openapi-validate-file-path) * [`safira-cli project update`](#safira-cli-project-update) * [`safira-cli upgrade`](#safira-cli-upgrade) ## `safira-cli argocd config-repo` Help you configure the GIT repository for your ArgoCD project ``` USAGE $ safira-cli argocd config-repo [--branch-name <value>] [--kubernetes-server <value>] FLAGS --branch-name=<value> branch name --kubernetes-server=<value> kubernetes server DESCRIPTION Help you configure the GIT repository for your ArgoCD project EXAMPLES $ safira-cli argocd config-repo ``` ## `safira-cli autocomplete [SHELL]` display autocomplete installation instructions ``` USAGE $ safira-cli autocomplete [SHELL] [-r] ARGUMENTS SHELL shell type FLAGS -r, --refresh-cache Refresh cache (ignores displaying instructions) DESCRIPTION display autocomplete installation instructions EXAMPLES $ safira-cli autocomplete $ safira-cli autocomplete bash $ safira-cli autocomplete zsh $ safira-cli autocomplete --refresh-cache ``` _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.10/src/commands/autocomplete/index.ts)_ ## `safira-cli bitbucket credential remove` Remove bitbucket credential ``` USAGE $ safira-cli bitbucket credential remove [--help] FLAGS --help Show CLI help. DESCRIPTION Remove bitbucket credential EXAMPLES $ safira-cli bitbucket credential remove ``` ## `safira-cli bitbucket credential set` Configure bitbucket credential ``` USAGE $ safira-cli bitbucket credential set [--help] [-t <value>] FLAGS -t, --token=<value> token --help Show CLI help. DESCRIPTION Configure bitbucket credential EXAMPLES $ safira-cli bitbucket credential set $ safira-cli bitbucket credential set --email=xxxx --username=xxxx --token=xxxx ``` ## `safira-cli commands` list all the commands ``` USAGE $ safira-cli commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ] FLAGS -h, --help Show CLI help. -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 --hidden show hidden commands --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) --tree show tree of commands GLOBAL FLAGS --json Format output as json. DESCRIPTION list all the commands ``` _See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v2.2.2/src/commands/commands.ts)_ ## `safira-cli devportal install` Install the Devportal ``` USAGE $ safira-cli devportal install [--domain <value>] [--secure yes|no] [--okta-client-id <value>] [--okta-client-secret <value>] [--okta-id <value>] [--spec-house-branch <value>] [--spec-house-provider github] [--spec-house-owner-repo <value>] FLAGS --domain=<value> domain --okta-client-id=<value> okta clientid --okta-client-secret=<value> okta clientsecret --okta-id=<value> okta account id --secure=<option> secure <options: yes|no> --spec-house-branch=<value> branch to listen specs --spec-house-owner-repo=<value> owner/repo --spec-house-provider=<option> spec house provider <options: github> DESCRIPTION Install the Devportal EXAMPLES $ safira-cli devportal install ``` ## `safira-cli devportal remove` Remove the Devportal ``` USAGE $ safira-cli devportal remove [-h] FLAGS -h, --help Show CLI help. DESCRIPTION Remove the Devportal EXAMPLES $ safira-cli devportal remove ``` ## `safira-cli devportal stack install` Install devportal stack ``` USAGE $ safira-cli devportal stack install [-n <value>] [-f] FLAGS -f, --force -n, --name=<value> name to print DESCRIPTION Install devportal stack EXAMPLES $ safira-cli devportal stack install ``` ## `safira-cli devportal stack remove` Remove devportal stack ``` USAGE $ safira-cli devportal stack remove [-n <value>] [-f] FLAGS -f, --force -n, --name=<value> name to print DESCRIPTION Remove devportal stack EXAMPLES $ safira-cli devportal stack remove ``` ## `safira-cli doctor` Check the health of the dependencies ``` USAGE $ safira-cli doctor [-d] [--file <value>] FLAGS -d, --dev --file=<value> DESCRIPTION Check the health of the dependencies EXAMPLES $ safira-cli doctor ``` _See code: [dist/commands/doctor.ts](https://github.com/veecode-platform/safira-cli/blob/v0.11.5/dist/commands/doctor.ts)_ ## `safira-cli github credential remove` Remove github credential ``` USAGE $ safira-cli github credential remove [--help] FLAGS --help Show CLI help. DESCRIPTION Remove github credential EXAMPLES $ safira-cli github credential remove ``` ## `safira-cli github credential set` Configure github credential ``` USAGE $ safira-cli github credential set [--help] [-t <value>] FLAGS -t, --token=<value> token --help Show CLI help. DESCRIPTION Configure github credential EXAMPLES $ safira-cli github credential set $ safira-cli github credential set --email=xxxx --username=xxxx --token=xxxx ``` ## `safira-cli gitlab credential remove` Remove gitlab credential ``` USAGE $ safira-cli gitlab credential remove [--help] FLAGS --help Show CLI help. DESCRIPTION Remove gitlab credential EXAMPLES $ safira-cli gitlab credential remove ``` ## `safira-cli gitlab credential set` Configure gitlab credential ``` USAGE $ safira-cli gitlab credential set [--help] [-t <value>] FLAGS -t, --token=<value> token --help Show CLI help. DESCRIPTION Configure gitlab credential EXAMPLES $ safira-cli gitlab credential set $ safira-cli gitlab credential set --email=xxxx --username=xxxx --token=xxxx ``` ## `safira-cli help [COMMAND]` Display help for safira-cli. ``` USAGE $ safira-cli help [COMMAND] [-n] ARGUMENTS COMMAND Command to show help for. FLAGS -n, --nested-commands Include all nested commands in the output. DESCRIPTION Display help for safira-cli. ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.23/src/commands/help.ts)_ ## `safira-cli insomnia export` Export your insomnia spec ``` USAGE $ safira-cli insomnia export [-h] FLAGS -h, --help Show CLI help. DESCRIPTION Export your insomnia spec ``` ## `safira-cli insomnia test` Run your insomnia test ``` USAGE $ safira-cli insomnia test [-h] [--inso-spec-name <value>] FLAGS -h, --help Show CLI help. --inso-spec-name=<value> The name of the INSO specification. DESCRIPTION Run your insomnia test ``` ## `safira-cli keycloak install` Install the Keycloak in the Kubernetes cluster ``` USAGE $ safira-cli keycloak install [--help] [--domain <value>] [--secure yes|no] [--admin-username <value>] [--admin-password <value>] [--HA yes|no] [--ssl yes|no] FLAGS --HA=<option> High availability mode <options: yes|no> --admin-password=<value> Admin password --admin-username=<value> Admin username --domain=<value> Domain name --help Show CLI help. --secure=<option> secure <options: yes|no> --ssl=<option> Specifies if the keycloak will be using internal SSL certificates <options: yes|no> DESCRIPTION Install the Keycloak in the Kubernetes cluster EXAMPLES $ safira-cli keycloak install ``` ## `safira-cli keycloak remove` describe the command here ``` USAGE $ safira-cli keycloak remove [--help] FLAGS --help Show CLI help. DESCRIPTION describe the command here EXAMPLES $ safira-cli keycloak remove ``` ## `safira-cli mockserver install` Install a mockserver ``` USAGE $ safira-cli mockserver install [--domain <value>] [--secure yes|no] [--ssl yes|no] [--crt-file <value>] [--key-file <value>] [--secure-admin yes|no] [--cors <value>] FLAGS --cors=<value> List of hosts to configure Cors --crt-file=<value> Specifies the mockserver .crt file path --domain=<value> Specifies the domain to use in the application --key-file=<value> Specifies the mockserver .key file path --secure=<option> Specifies if the application will have HTTPS <options: yes|no> --secure-admin=<option> Specifies if CPanel must be secured with apikey <options: yes|no> --ssl=<option> Specifies if the application will have HTTPS <options: yes|no> DESCRIPTION Install a mockserver EXAMPLES $ safira-cli mockserver install ``` ## `safira-cli mockserver remove` Remove mockserver ``` USAGE $ safira-cli mockserver remove [--help] FLAGS --help Show CLI help. DESCRIPTION Remove mockserver EXAMPLES $ safira-cli mockserver remove ``` ## `safira-cli mockserver spec deploy` Deploys the spec to the mock server ``` USAGE $ safira-cli mockserver spec deploy [--help] [--server-url <value>] [--context <value>] [--api-key <value>] FLAGS --api-key=<value> api key --context=<value> api context --help Show CLI help. --server-url=<value> mock server url DESCRIPTION Deploys the spec to the mock server EXAMPLES $ safira-cli mockserver spec deploy ``` ## `safira-cli okta credential remove` Remove Okta credential ``` USAGE $ safira-cli okta credential remove [--help] FLAGS --help Show CLI help. DESCRIPTION Remove Okta credential EXAMPLES $ safira-cli okta credential remove ``` ## `safira-cli okta credential set` Configure Okta credential ``` USAGE $ safira-cli okta credential set [--help] [-a <value>] [-s <value>] FLAGS -a, --client-id=<value> Okta client id -s, --client-secret=<value> Okta client secret --help Show CLI help. DESCRIPTION Configure Okta credential EXAMPLES $ safira-cli okta credential set $ safira-cli okta credential set --client-id=xxxx --client-secret=xxxx ``` ## `safira-cli openapi validate [FILE-PATH]` Validates your openapi file.Supports json or yaml file. ``` USAGE $ safira-cli openapi validate [FILE-PATH] [--help] ARGUMENTS FILE-PATH [default: ./openapi-swagger.yaml] Openapi template file location FLAGS --help Show CLI help. DESCRIPTION Validates your openapi file.Supports json or yaml file. EXAMPLES $ safira-cli openapi validate $ safira-cli openapi validate ./openapi-swagger.json $ safira-cli openapi validate ./openapi-swagger.yaml ``` ## `safira-cli plugins` List installed plugins. ``` USAGE $ safira-cli plugins [--core] FLAGS --core Show core plugins. DESCRIPTION List installed plugins. EXAMPLES $ safira-cli plugins ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.12/src/commands/plugins/index.ts)_ ## `safira-cli plugins:install PLUGIN...` Installs a plugin into the CLI. ``` USAGE $ safira-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 $ safira-cli plugins add EXAMPLES $ safira-cli plugins:install myplugin $ safira-cli plugins:install https://github.com/someuser/someplugin $ safira-cli plugins:install someuser/someplugin ``` ## `safira-cli plugins:inspect PLUGIN...` Displays installation properties of a plugin. ``` USAGE $ safira-cli plugins:inspect PLUGIN... ARGUMENTS PLUGIN [default: .] Plugin to inspect. FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Displays installation properties of a plugin. EXAMPLES $ safira-cli plugins:inspect myplugin ``` ## `safira-cli plugins:install PLUGIN...` Installs a plugin into the CLI. ``` USAGE $ safira-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 $ safira-cli plugins add EXAMPLES $ safira-cli plugins:install myplugin $ safira-cli plugins:install https://github.com/someuser/someplugin $ safira-cli plugins:install someuser/someplugin ``` ## `safira-cli plugins:link PLUGIN` Links a plugin into the CLI for development. ``` USAGE $ safira-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 $ safira-cli plugins:link myplugin ``` ## `safira-cli plugins:uninstall PLUGIN...` Removes a plugin from the CLI. ``` USAGE $ safira-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 $ safira-cli plugins unlink $ safira-cli plugins remove ``` ## `safira-cli plugins:uninstall PLUGIN...` Removes a plugin from the CLI. ``` USAGE $ safira-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 $ safira-cli plugins unlink $ safira-cli plugins remove ``` ## `safira-cli plugins:uninstall PLUGIN...` Removes a plugin from the CLI. ``` USAGE $ safira-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 $ safira-cli plugins unlink $ safira-cli plugins remove ``` ## `safira-cli plugins update` Update installed plugins. ``` USAGE $ safira-cli plugins update [-h] [-v] FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Update installed plugins. ``` ## `safira-cli project update` Update an existing safira project ``` USAGE $ safira-cli project update [-h] [-o <value>] [-i <value>] [--inso-spec-name <value>] FLAGS -h, --help Show CLI help. -i, --insomnia-workspace=<value> Import OpenAPI file from the INSOMNIA Workspace. -o, --openapi-file-path=<value> The path to the OpenAPI file. --inso-spec-name=<value> The name of the INSO specification. DESCRIPTION Update an existing safira project ``` ## `safira-cli spec configure` Publish a spec file using pipeline ``` USAGE $ safira-cli spec configure [-s <value>] FLAGS -s, --select-spec=<value> Select the spec to publish. DESCRIPTION Publish a spec file using pipeline EXAMPLES $ safira-cli spec configure ``` ## `safira-cli spec publish` Publish a spec directly to devPortal ``` USAGE $ safira-cli spec publish [-n <value>] [-f] FLAGS -f, --force -n, --name=<value> name to print DESCRIPTION Publish a spec directly to devPortal EXAMPLES $ safira-cli spec publish ``` ## `safira-cli upgrade` Safira-CLI upgrade ``` USAGE $ safira-cli upgrade DESCRIPTION Safira-CLI upgrade EXAMPLES $ safira-cli upgrade ``` _See code: [dist/commands/upgrade.ts](https://github.com/veecode-platform/safira-cli/blob/v0.11.5/dist/commands/upgrade.ts)_