safira-cli
safira-cli.
Requiments
Before install safira-cli, check if you have installed the following dependencies:
Usage
$ npm install -g @vfipaas/safira-cli
$ safira-cli COMMAND
running command...
$ safira-cli (--version)
@vfipaas/safira-cli/0.6.0 linux-x64 node-v16.15.1
$ safira-cli --help [COMMAND]
USAGE
$ safira-cli COMMAND
...
Commands
safira-cli argocd config-repo
safira-cli argocd install
safira-cli argocd remove
safira-cli autocomplete [SHELL]
safira-cli aws credential remove
safira-cli aws credential set
safira-cli bitbucket credential remove
safira-cli bitbucket credential set
safira-cli cicd configure
safira-cli commands
safira-cli docker credential remove
safira-cli docker credential set
safira-cli doctor
safira-cli github credential remove
safira-cli github credential set
safira-cli gitlab credential remove
safira-cli gitlab credential set
safira-cli help [COMMAND]
safira-cli insomnia test
safira-cli kong deploy
safira-cli kong remove
safira-cli mockserver install
safira-cli mockserver remove
safira-cli mockserver spec deploy [FILE]
safira-cli okteto context
safira-cli okteto down
safira-cli okteto up
safira-cli openapi validate [FILE-PATH]
safira-cli project build-publish
safira-cli project new [PROJECT-NAME]
safira-cli project update
safira-cli spec publish
safira-cli argocd config-repo
Help you configure the GIT repository for your ArgoCD project
USAGE
$ safira-cli argocd config-repo
DESCRIPTION
Help you configure the GIT repository for your ArgoCD project
EXAMPLES
$ safira-cli argocd config-repo
safira-cli argocd install
Install the ArgoCD in the Kubernetes cluster
USAGE
$ safira-cli argocd install [-h] [--HA yes|no] [--default yes|no] [--domain <value>] [--secure yes|no] [-a yes|no]
FLAGS
-a, --verbose=<option> Verbose mode (All). Indicate to a formula that it should show log messages in more detail
<options: yes|no>
-h, --help Show CLI help.
--HA=<option> High Availability instance
<options: yes|no>
--default=<option> Use to automatically fill inputs with default value provided on config.json
<options: yes|no>
--domain=<value> [default: localhost] Domain
--secure=<option> Secure
<options: yes|no>
DESCRIPTION
Install the ArgoCD in the Kubernetes cluster
safira-cli argocd remove
describe the command here
USAGE
$ safira-cli argocd remove [-h] [-a]
FLAGS
-a, --verbose Verbose mode (All). Indicate to a formula that it should show log messages in more detail
-h, --help Show CLI help.
DESCRIPTION
describe the command here
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
safira-cli aws credential remove
Remove AWS credential
USAGE
$ safira-cli aws credential remove [--help]
FLAGS
--help Show CLI help.
DESCRIPTION
Remove AWS credential
EXAMPLES
$ safira-cli aws credential remove
safira-cli aws credential set
Configure Docker Hub credential
USAGE
$ safira-cli aws credential set [--help] [-a <value>] [-s <value>]
FLAGS
-a, --access-key-id=<value> AWS access key id
-s, --secret-access-key=<value> AWS secret access key
--help Show CLI help.
DESCRIPTION
Configure Docker Hub credential
EXAMPLES
$ safira-cli aws credential set
$ safira-cli aws credential set --username=username --password=password
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] [-e <value>] [-u <value>] [-t <value>]
FLAGS
-e, --email=<value> email
-t, --token=<value> token
-u, --username=<value> username
--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 cicd configure
Help you configure your CI/CD pipeline for your project
USAGE
$ safira-cli cicd configure [--help]
FLAGS
--help Show CLI help.
DESCRIPTION
Help you configure your CI/CD pipeline for your project
EXAMPLES
$ safira-cli cicd configure
safira-cli commands
list all the commands
USAGE
$ safira-cli commands [--json] [-h] [--hidden] [--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)
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
list all the commands
See code: @oclif/plugin-commands
safira-cli docker credential remove
Remove Docker Registry credential
USAGE
$ safira-cli docker credential remove [--help]
FLAGS
--help Show CLI help.
DESCRIPTION
Remove Docker Registry credential
EXAMPLES
$ safira-cli docker credential remove
safira-cli docker credential set
Configure Docker Registry credential
USAGE
$ safira-cli docker credential set [--help] [-a <value>] [-s <value>] [-n <value>] [-h <value>]
FLAGS
-a, --username=<value> Registry username
-h, --host=<value> Registry host
-n, --registry-name=<value> Registry name
-s, --password=<value> Registry password
--help Show CLI help.
DESCRIPTION
Configure Docker Registry credential
EXAMPLES
$ safira-cli docker credential set
safira-cli doctor
Check the health of the dependencies
USAGE
$ safira-cli doctor
DESCRIPTION
Check the health of the dependencies
EXAMPLES
$ safira-cli doctor
See code: 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] [-e <value>] [-u <value>] [-t <value>]
FLAGS
-e, --email=<value> email
-t, --token=<value> token
-u, --username=<value> username
--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] [-e <value>] [-u <value>] [-t <value>]
FLAGS
-e, --email=<value> email
-t, --token=<value> token
-u, --username=<value> username
--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
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 kong deploy
Install Kong in your k8s cluster
USAGE
$ safira-cli kong deploy [--help] [--domain <value>] [--secure yes|no] [--mode dbless|hybrid|standard]
[--enterprise yes|no] [--license <value>]
FLAGS
--domain=<value> domain
--enterprise=<option> Kong enterprise
<options: yes|no>
--help Show CLI help.
--license=<value> Path to license file
--mode=<option> Kong mode (Hybrid only available in Kong Enterprise)
<options: dbless|hybrid|standard>
--secure=<option> secure
<options: yes|no>
DESCRIPTION
Install Kong in your k8s cluster
EXAMPLES
$ safira-cli kong deploy
safira-cli kong remove
Remove kong
USAGE
$ safira-cli kong remove [--help] [--domain <value>] [--secure yes|no] [--mode dbless|hybrid|standard]
[--enterprise yes|no] [--license <value>]
FLAGS
--domain=<value> domain
--enterprise=<option> Kong enterprise
<options: yes|no>
--help Show CLI help.
--license=<value> Path to license file
--mode=<option> Kong mode (Hybrid only available in Kong Enterprise)
<options: dbless|hybrid|standard>
--secure=<option> secure
<options: yes|no>
DESCRIPTION
Remove kong
EXAMPLES
$ safira-cli kong remove
safira-cli mockserver install
Install a mockserver
USAGE
$ safira-cli mockserver install [--domain <value>] [--secure yes|no]
FLAGS
--domain=<value> Specifies the domain to use in the application
--secure=<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 [FILE]
Deploys the spec to the mock server
USAGE
$ safira-cli mockserver spec deploy [FILE] [--help] [--server-url <value>] [--openapi-file <value>] [--context <value>]
[--insomnia-workspace-name <value> --insomnia-workspace-path <value>]
FLAGS
--context=<value> api context
--help Show CLI help.
--insomnia-workspace-name=<value> insomnia workspace name
--insomnia-workspace-path=<value> insomnia workspace path
--openapi-file=<value> openapi file
--server-url=<value> mock server url
DESCRIPTION
Deploys the spec to the mock server
EXAMPLES
$ safira-cli mockserver spec deploy
safira-cli okteto context
Change Okteto context
USAGE
$ safira-cli okteto context [--help]
FLAGS
--help help for context
DESCRIPTION
Change Okteto context
safira-cli okteto down
Destroy development container
USAGE
$ safira-cli okteto down [-c <value>] [-f <value>] [--help] [-n <value>] [--volumes]
FLAGS
-c, --context=<value> context where the down command is executed
-f, --file=<value> path to the manifest file (default 'okteto.yml')
-n, --namespace=<value> namespace where the up command is executed
--help help for down
--volumes remove persistent volume
DESCRIPTION
Destroy development container
safira-cli okteto up
Activate your development container
USAGE
$ safira-cli okteto up [--build] [-c <value>] [-f <value>] [--help] [-n <value>] [--pull] [-r <value>]
[--reset] [-l <value>]
FLAGS
-c, --context=<value> context where the up command is executed
-f, --file=<value> path to the manifest file (default 'okteto.yml')
-l, --loglevel=<value> amount of information outputted (debug, info, warn, error) (default 'warn')
-n, --namespace=<value> namespace where the up command is executed
-r, --remote=<value> configures remote execution on the specified port
--build build on-the-fly the dev image using the info provided by the 'build' okteto manifest field
--help help for up
--pull force dev image pull
--reset reset the file synchronization database
DESCRIPTION
Activate your development container
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.json] 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-sample.json
$ safira-cli openapi validate ./openapi-sample.yaml
safira-cli project build-publish
Build your project generating docker image.
USAGE
$ safira-cli project build-publish [--help] [--docker-file <value>] [-v <value>] [--skip-test yes|no]
FLAGS
-v, --version=<value> App Version
--docker-file=<value> Dockerfile path
--help Show CLI help.
--skip-test=<option> Skip test
<options: yes|no>
DESCRIPTION
Build your project generating docker image.
EXAMPLES
$ safira-cli project build-publish
$ safira-cli project build-publish --version 1.0.0 --skip-test true
$ safira-cli project build-publish --docker-file ./src/main/docker/Dockerfile
safira-cli project new [PROJECT-NAME]
Create a new project
USAGE
$ safira-cli project new [PROJECT-NAME] [--help] [-l <value>] [-f springboot|quarkus] [--new-project-root
<value>] [-o <value>] [-i <value>] [--inso-spec-name <value>] [--project-description <value>] [--java-pack-manager
gradle|maven] [--java-springboot-version <value>] [--java-package <value>] [--java-version java8|java11|java17]
[--application-port <value>] [--kong-kubernetes yes|no] [--use-database yes|no] [--database
postgresql|mysql|mariadb|oracle] [--database-url <value>] [--database-user <value>] [--database-password <value>]
[--export-spec yes|no] [--quarkus-version <value>]
ARGUMENTS
PROJECT-NAME Use '.' to create project into current folder or name of the project to create a new folder.User
lowercase letters for the project name.
FLAGS
-f, --framework=(springboot|quarkus)
-i, --insomnia-workspace=<value> Import OpenAPI file from the INSO Workspace.
-l, --language=java Programming language to use
-o, --openapi-file-path=<value> The path to the OpenAPI file.
--application-port=8080 Application port
--database=<option> The database provider
<options: postgresql|mysql|mariadb|oracle>
--database-password=password123 The password of the database
--database-url=localhost:5432/database The url of the database
--database-user=User The user of the database
--export-spec=<option> Export spec
<options: yes|no>
--help Show CLI help.
--inso-spec-name=<value> The name of the INSO specification.
--java-pack-manager=(gradle|maven) Java package management
--java-package=com.safira.demo Java package
--java-springboot-version=2.5.13 Springboot version
--java-version=(java8|java11|java17) Java version
--kong-kubernetes=<option> Generate Kong for Kubernetes configuration
<options: yes|no>
--new-project-root=<value> The path where new projects will be created, relative to the new workspace
root.
--project-description=<value> The description of the new project.
--quarkus-version=<value> Quarkus version
--use-database=<option> Use database
<options: yes|no>
DESCRIPTION
Create a new project
EXAMPLES
$ safira-cli project new
$ safira-cli project new app-name
$ safira-cli project new app-name --language java11 --java-pack-manager gradle --application-port 8090
$ safira-cli project new . -create a project in the current folder
safira-cli project update
describe the command here
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
describe the command here
safira-cli spec publish
Pulbish a spec file
USAGE
$ safira-cli spec publish [-s <value>]
FLAGS
-s, --select-spec=<value> Select the spec to publish.
DESCRIPTION
Pulbish a spec file
EXAMPLES
$ safira-cli spec publish