Latest Threat Research:SANDWORM_MODE: Shai-Hulud-Style npm Worm Hijacks CI Workflows and Poisons AI Toolchains.Details
Socket
Book a DemoInstallSign in
Socket

@veecode-platform/safira-cli

Package Overview
Dependencies
Maintainers
2
Versions
11
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@veecode-platform/safira-cli

Generate a microservice project from your spec.

npmnpm
Version
0.11.1
Version published
Weekly downloads
0
Maintainers
2
Weekly downloads
 
Created
Source

safira-cli

safira-cli.

oclif Version

Downloads/week License

Requiments

Before install safira-cli, check if you have installed the following dependencies:

Usage

$ npm install -g @veecode-platform/safira-cli
$ safira-cli COMMAND
running command...
$ safira-cli (--version)
@veecode-platform/safira-cli/0.11.1 linux-x64 node-v16.17.0
$ safira-cli --help [COMMAND]
USAGE
  $ safira-cli COMMAND
...

Commands

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 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

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

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

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 kong install

Install Kong in your k8s cluster

USAGE
  $ safira-cli kong install [--help] [--domain <value>] [--secure yes|no] [--mode dbless|hybrid|standard]
    [--license <value>] [--HA yes|no] [--rbac-password <value>] [--kong-plane control|data] [--kong-telemetry-url
    <value>] [--kong-cp-url <value>] [--postgres-password <value>]

FLAGS
  --HA=<option>                 Use High Availability mode
                                <options: yes|no>
  --domain=<value>              domain
  --help                        Show CLI help.
  --kong-cp-url=<value>         Specifies which Kong CP to point at
  --kong-plane=<option>         Specifies the Plane to install on Hybrid Mode
                                <options: control|data>
  --kong-telemetry-url=<value>  Specifies which telemetry endpoint
  --license=<value>             Path to license file
  --mode=<option>               Kong mode (Hybrid only available in Kong Enterprise)
                                <options: dbless|hybrid|standard>
  --postgres-password=<value>   Postgres password if in Hybrid or Standard Mode
  --rbac-password=<value>       RBAC password
  --secure=<option>             secure
                                <options: yes|no>

DESCRIPTION
  Install Kong in your k8s cluster

EXAMPLES
  $ safira-cli kong install

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] [--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 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-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 project new

Create a new project

USAGE
  $ safira-cli project new [--help] [-l <value>] [-f springboot|quarkus] [--new-project-root <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>]

FLAGS
  -f, --framework=(springboot|quarkus)
  -l, --language=java                     Programming language to use
  --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.
  --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

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

Keywords

microservices

FAQs

Package last updated on 26 Sep 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts