Skip to content

Small CLI utility for Snyk Universal Broker

License

Notifications You must be signed in to change notification settings

snyk/snyk-broker-config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

snyk-broker-config

Small utility to help with Universal Broker configuration and management

oclif Version Downloads/week

Usage

$ npm install -g snyk-broker-config
$ snyk-broker-config COMMAND
running command...
$ snyk-broker-config (--version)
snyk-broker-config/1.17.3 linux-x64 node-v20.14.0
$ snyk-broker-config --help [COMMAND]
USAGE
  $ snyk-broker-config COMMAND
...

Commands

snyk-broker-config autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ snyk-broker-config autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ snyk-broker-config autocomplete

  $ snyk-broker-config autocomplete bash

  $ snyk-broker-config autocomplete zsh

  $ snyk-broker-config autocomplete powershell

  $ snyk-broker-config autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

snyk-broker-config commands

List all snyk-broker-config commands.

USAGE
  $ snyk-broker-config commands [--json] [-c id|plugin|summary|type... | --tree] [--deprecated] [-x | ]
    [--hidden] [--no-truncate | ] [--sort id|plugin|summary|type | ]

FLAGS
  -c, --columns=<option>...  Only show provided columns (comma-separated).
                             <options: id|plugin|summary|type>
  -x, --extended             Show extra columns.
      --deprecated           Show deprecated commands.
      --hidden               Show hidden commands.
      --no-truncate          Do not truncate output.
      --sort=<option>        [default: id] Property to sort by.
                             <options: id|plugin|summary|type>
      --tree                 Show tree of commands.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all snyk-broker-config commands.

See code: @oclif/plugin-commands

snyk-broker-config connections create DEPLOYMENTID [APIURL] [APIVERSION]

Universal Broker Connections - Create operation

USAGE
  $ snyk-broker-config connections create DEPLOYMENTID [APIURL] [APIVERSION] -t <value> -n <value> [--checkmarx <value>]
    [--checkmarx_password <value>] [--checkmarx_username <value>] [--sonar_qube_host_url <value>]
    [--sonar_qube_api_token <value>] [--artifactory_url <value>] [--jira_hostname <value>] [--jira_username <value>]
    [--jira_password <value>] [--jira_pat <value>] [--base_nexus_url <value>] [--broker_client_url <value>]
    [--azure_repos_token <value>] [--azure_repos_org <value>] [--bitbucket <value>] [--bitbucket_username <value>]
    [--bitbucket_password <value>] [--bitbucket_pat <value>] [--github_token <value>] [--github <value>] [--github_api
    <value>] [--github_app_client_id <value>] [--github_app_id <value>] [--github_app_installation_id <value>]
    [--github_app_private_pem_path <value>] [--gitlab <value>] [--gitlab_token <value>] [--cr_agent_url <value>]
    [--cr_base <value>] [--cr_username <value>] [--cr_password <value>] [--cr_token <value>] [--cr_role_arn <value>]
    [--cr_region <value>] [--cr_external_id <value>]

ARGUMENTS
  DEPLOYMENTID  Deployment ID
  APIURL        [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION    [default: 2024-02-08~experimental] API Version

FLAGS
  -n, --name=<value>                         (required) Connection name
  -t, --type=<value>                         (required) Connection type
      --artifactory_url=<value>              Artifactory URL (Credentials Reference as it may contain sensitive values)
      --azure_repos_org=<value>              Azure Repos Org Name
      --azure_repos_token=<value>            Azure Repos Token Credentials Reference
      --base_nexus_url=<value>               Nexus URL (Credentials Reference as it may contain sensitive values)
      --bitbucket=<value>                    Bitbucket Hostname
      --bitbucket_password=<value>           Bitbucket Password Credentials Reference (leave empty if using PAT)
      --bitbucket_pat=<value>                Bitbucket Pat Credentials Reference (leave empty if using user/pass)
      --bitbucket_username=<value>           Bitbucket Username (leave empty if using PAT)
      --broker_client_url=<value>            Broker Client Url
      --checkmarx=<value>                    Checkmarx Hostname (leave empty if not using Checkmarx)
      --checkmarx_password=<value>           Checkmarx Password Credentials Reference (leave empty if not using
                                             Checkmarx)
      --checkmarx_username=<value>           Checkmarx Username (leave empty if not using Checkmarx)
      --cr_agent_url=<value>                 CR Agent Url
      --cr_base=<value>                      CR Base Url
      --cr_external_id=<value>               CR External ID
      --cr_password=<value>                  CR Password Credentials Reference
      --cr_region=<value>                    CR Region
      --cr_role_arn=<value>                  CR Role Arn
      --cr_token=<value>                     CR Token Credentials Reference
      --cr_username=<value>                  CR Username
      --github=<value>                       Github Url
      --github_api=<value>                   Github Api Url
      --github_app_client_id=<value>         Github App Client ID Credentials Refs
      --github_app_id=<value>                Github App ID
      --github_app_installation_id=<value>   Github App Installation ID
      --github_app_private_pem_path=<value>  Github Private Pem cert path
      --github_token=<value>                 Github Token Credentials Reference
      --gitlab=<value>                       Gitlab Hostname
      --gitlab_token=<value>                 Gitlab Token Credentials Reference
      --jira_hostname=<value>                Jira Hostname
      --jira_password=<value>                Jira Password Credentials Reference (leave empty if using PAT)
      --jira_pat=<value>                     JIRA Pat Reference (leave empty if using user/pass)
      --jira_username=<value>                Jira Username (leave empty if using PAT)
      --sonar_qube_api_token=<value>         Sonarqube Api token (leave empty if not using Sonarqube)
      --sonar_qube_host_url=<value>          Sonarqube Hostname (leave empty if not using Sonarqube)

DESCRIPTION
  Universal Broker Connections - Create operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config connections create DEPLOYMENT_ID --type github

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config connections create TENANT_ID INSTALL_ID DEPLOYMENT_ID --type github

See code: src/commands/connections/create.ts

snyk-broker-config connections delete DEPLOYMENTID CONNECTIONID [APIURL] [APIVERSION]

Universal Broker Connections - Delete operation

USAGE
  $ snyk-broker-config connections delete DEPLOYMENTID CONNECTIONID [APIURL] [APIVERSION] [--json] [--log-level
    debug|warn|error|info|trace]

ARGUMENTS
  DEPLOYMENTID  Deployment ID
  CONNECTIONID  Connection ID
  APIURL        [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION    [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Connections - Delete operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config connections delete DEPLOYMENT_ID CONNECTION_ID

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config connections delete TENANT_ID INSTALL_ID DEPLOYMENT_ID CONNECTION_ID

See code: src/commands/connections/delete.ts

snyk-broker-config connections list DEPLOYMENTID [APIURL] [APIVERSION]

Universal Broker Connections - List operation

USAGE
  $ snyk-broker-config connections list DEPLOYMENTID [APIURL] [APIVERSION] [--json] [--log-level
    debug|warn|error|info|trace]

ARGUMENTS
  DEPLOYMENTID  Deployment ID
  APIURL        [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION    [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Connections - List operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config connections list DEPLOYMENT_ID

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config connections list TENANT_ID INSTALL_ID DEPLOYMENT_ID

See code: src/commands/connections/list.ts

snyk-broker-config connections update DEPLOYMENTID CONNECTIONID [APIURL] [APIVERSION]

Universal Broker Connections - Update operation

USAGE
  $ snyk-broker-config connections update DEPLOYMENTID CONNECTIONID [APIURL] [APIVERSION] -t <value> -n <value>
    [--checkmarx <value>] [--checkmarx_password <value>] [--checkmarx_username <value>] [--sonar_qube_host_url <value>]
    [--sonar_qube_api_token <value>] [--artifactory_url <value>] [--jira_hostname <value>] [--jira_username <value>]
    [--jira_password <value>] [--jira_pat <value>] [--base_nexus_url <value>] [--broker_client_url <value>]
    [--azure_repos_token <value>] [--azure_repos_org <value>] [--bitbucket <value>] [--bitbucket_username <value>]
    [--bitbucket_password <value>] [--bitbucket_pat <value>] [--github_token <value>] [--github <value>] [--github_api
    <value>] [--github_app_client_id <value>] [--github_app_id <value>] [--github_app_installation_id <value>]
    [--github_app_private_pem_path <value>] [--gitlab <value>] [--gitlab_token <value>] [--cr_agent_url <value>]
    [--cr_base <value>] [--cr_username <value>] [--cr_password <value>] [--cr_token <value>] [--cr_role_arn <value>]
    [--cr_region <value>] [--cr_external_id <value>]

ARGUMENTS
  DEPLOYMENTID  Deployment ID
  CONNECTIONID  Connection ID
  APIURL        [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION    [default: 2024-02-08~experimental] API Version

FLAGS
  -n, --name=<value>                         (required) Connection name
  -t, --type=<value>                         (required) Connection type
      --artifactory_url=<value>              Artifactory URL (Credentials Reference as it may contain sensitive values)
      --azure_repos_org=<value>              Azure Repos Org Name
      --azure_repos_token=<value>            Azure Repos Token Credentials Reference
      --base_nexus_url=<value>               Nexus URL (Credentials Reference as it may contain sensitive values)
      --bitbucket=<value>                    Bitbucket Hostname
      --bitbucket_password=<value>           Bitbucket Password Credentials Reference (leave empty if using PAT)
      --bitbucket_pat=<value>                Bitbucket Pat Credentials Reference (leave empty if using user/pass)
      --bitbucket_username=<value>           Bitbucket Username (leave empty if using PAT)
      --broker_client_url=<value>            Broker Client Url
      --checkmarx=<value>                    Checkmarx Hostname (leave empty if not using Checkmarx)
      --checkmarx_password=<value>           Checkmarx Password Credentials Reference (leave empty if not using
                                             Checkmarx)
      --checkmarx_username=<value>           Checkmarx Username (leave empty if not using Checkmarx)
      --cr_agent_url=<value>                 CR Agent Url
      --cr_base=<value>                      CR Base Url
      --cr_external_id=<value>               CR External ID
      --cr_password=<value>                  CR Password Credentials Reference
      --cr_region=<value>                    CR Region
      --cr_role_arn=<value>                  CR Role Arn
      --cr_token=<value>                     CR Token Credentials Reference
      --cr_username=<value>                  CR Username
      --github=<value>                       Github Url
      --github_api=<value>                   Github Api Url
      --github_app_client_id=<value>         Github App Client ID Credentials Refs
      --github_app_id=<value>                Github App ID
      --github_app_installation_id=<value>   Github App Installation ID
      --github_app_private_pem_path=<value>  Github Private Pem cert path
      --github_token=<value>                 Github Token Credentials Reference
      --gitlab=<value>                       Gitlab Hostname
      --gitlab_token=<value>                 Gitlab Token Credentials Reference
      --jira_hostname=<value>                Jira Hostname
      --jira_password=<value>                Jira Password Credentials Reference (leave empty if using PAT)
      --jira_pat=<value>                     JIRA Pat Reference (leave empty if using user/pass)
      --jira_username=<value>                Jira Username (leave empty if using PAT)
      --sonar_qube_api_token=<value>         Sonarqube Api token (leave empty if not using Sonarqube)
      --sonar_qube_host_url=<value>          Sonarqube Hostname (leave empty if not using Sonarqube)

DESCRIPTION
  Universal Broker Connections - Update operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config connections update DEPLOYMENT_ID CONNECTION_ID --type github

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config connections update TENANT_ID INSTALL_ID DEPLOYMENT_ID CONNECTION_ID --type github

See code: src/commands/connections/update.ts

snyk-broker-config credentials create DEPLOYMENTID [APIURL] [APIVERSION]

Universal Broker Credentials - Create operation

USAGE
  $ snyk-broker-config credentials create DEPLOYMENTID [APIURL] [APIVERSION] -c <value> -n <value> -t <value> [--json]
    [--log-level debug|warn|error|info|trace]

ARGUMENTS
  DEPLOYMENTID  Deployment ID
  APIURL        [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION    [default: 2024-02-08~experimental] API Version

FLAGS
  -c, --comment=<value>       (required) Comment about credentials reference(s).
  -n, --env_var_name=<value>  (required) Env var name(s) of the credentials reference(s). Comma separated to specify
                              more than one at a time.
  -t, --type=<value>          (required) Connection type

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Credentials - Create operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config credentials create DEPLOYMENT_ID --comment "mycomment" --env_var_name MY_GITHUB_TOKEN --type github

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config credentials create TENANT_ID INSTALL_ID DEPLOYMENT_ID --comment "mycomment" --env_var_name MY_GITHUB_TOKEN --type github

See code: src/commands/credentials/create.ts

snyk-broker-config credentials delete DEPLOYMENTID [APIURL] [APIVERSION]

Universal Broker Deployment Credentials - Delete operation

USAGE
  $ snyk-broker-config credentials delete DEPLOYMENTID [APIURL] [APIVERSION] -c <value> [--json] [--log-level
    debug|warn|error|info|trace]

ARGUMENTS
  DEPLOYMENTID  Deployment ID
  APIURL        [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION    [default: 2024-02-08~experimental] API Version

FLAGS
  -c, --credentialsIds=<value>  (required) Credentials reference(s) ID(s).

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Deployment Credentials - Delete operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config credentials delete DEPLOYMENT_ID -c CREDENTIALS_ID

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config credentials delete TENANT_ID INSTALL_ID DEPLOYMENT_ID -c CREDENTIALS_ID

See code: src/commands/credentials/delete.ts

snyk-broker-config credentials list DEPLOYMENTID [APIURL] [APIVERSION]

Universal Broker Deployments - List operation

USAGE
  $ snyk-broker-config credentials list DEPLOYMENTID [APIURL] [APIVERSION] [--json] [--log-level
    debug|warn|error|info|trace]

ARGUMENTS
  DEPLOYMENTID  Deployment ID
  APIURL        [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION    [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Deployments - List operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config credentials list DEPLOYMENT_ID

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config credentials list TENANT_ID INSTALL_ID DEPLOYMENT_ID

See code: src/commands/credentials/list.ts

snyk-broker-config credentials update DEPLOYMENTID [APIURL] [APIVERSION]

Universal Broker Credentials - Update operation

USAGE
  $ snyk-broker-config credentials update DEPLOYMENTID [APIURL] [APIVERSION] -i <value> -c <value> -n <value> -t <value>
    [--json] [--log-level debug|warn|error|info|trace]

ARGUMENTS
  DEPLOYMENTID  Deployment ID
  APIURL        [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION    [default: 2024-02-08~experimental] API Version

FLAGS
  -c, --comment=<value>        (required) Comment about credentials reference(s).
  -i, --credentialsId=<value>  (required) Credentials reference ID.
  -n, --env_var_name=<value>   (required) Env var name(s) of the credentials reference(s). Comma separated to specify
                               more than one at a time.
  -t, --type=<value>           (required) Connection type

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Credentials - Update operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config credentials update DEPLOYMENT_ID --credentialsId CREDENTIALID--comment "mycomment" --env_var_name MY_GITHUB_TOKEN --type github

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config credentials update TENANT_ID INSTALL_ID DEPLOYMENT_ID --credentialsId CREDENTIALID --comment "mycomment" --env_var_name MY_GITHUB_TOKEN --type github

See code: src/commands/credentials/update.ts

snyk-broker-config deployments create APPINSTALLEDINORGID [APIURL] [APIVERSION]

Universal Broker Deployments - Create operation

USAGE
  $ snyk-broker-config deployments create APPINSTALLEDINORGID [APIURL] [APIVERSION] -d <value> [--json] [--log-level
    debug|warn|error|info|trace]

ARGUMENTS
  APPINSTALLEDINORGID  Broker App Installed in Org ID
  APIURL               [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION           [default: 2024-02-08~experimental] API Version

FLAGS
  -d, --data=<value>  (required) A series of key/value pairs comma separated. Ex:
                      cluster=my_cluster,deployment_name=test

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Deployments - Create operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config deployments create APP_INSTALLED_ORG_ID --data mykey=myvalue,mykey2=myvalue2

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config deployments create TENANT_ID INSTALL_ID APP_INSTALLED_ORG_ID --data mykey=myvalue,mykey2=myvalue2

See code: src/commands/deployments/create.ts

snyk-broker-config deployments delete DEPLOYMENTID

Universal Broker Deployments - Delete operation

USAGE
  $ snyk-broker-config deployments delete DEPLOYMENTID [--json] [--log-level debug|warn|error|info|trace]

ARGUMENTS
  DEPLOYMENTID  Deployment ID

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Deployments - Delete operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config deployments delete DEPLOYMENT_ID

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config deployments delete TENANT_ID INSTALL_ID DEPLOYMENT_ID

See code: src/commands/deployments/delete.ts

snyk-broker-config deployments list [APIURL] [APIVERSION]

Universal Broker Deployments - List operation

USAGE
  $ snyk-broker-config deployments list [APIURL] [APIVERSION] [--json] [--log-level debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Deployments - List operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config deployments list

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config deployments list TENANT_ID INSTALL_ID

See code: src/commands/deployments/list.ts

snyk-broker-config deployments update DEPLOYMENTID

Universal Broker Deployments - Update operation

USAGE
  $ snyk-broker-config deployments update DEPLOYMENTID -d <value> [--json] [--log-level debug|warn|error|info|trace]

ARGUMENTS
  DEPLOYMENTID  Deployment ID

FLAGS
  -d, --data=<value>  (required) A series of key/value pairs comma separated. Ex:
                      cluster=my_cluster,deployment_name=test

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Deployments - Update operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config deployments update DEPLOYMENT_ID --data mykey=myvalue,mykey2=myvalue2

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config deployments update TENANT_ID INSTALL_ID DEPLOYMENT_ID --data mykey=myvalue,mykey2=myvalue2

See code: src/commands/deployments/update.ts

snyk-broker-config help [COMMAND]

Display help for snyk-broker-config.

USAGE
  $ snyk-broker-config 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 snyk-broker-config.

See code: @oclif/plugin-help

snyk-broker-config integrations create CONNECTIONID ORGID INTEGRATIONID TYPE [APIURL] [APIVERSION]

Universal Broker Connections Integrations - Create operation

USAGE
  $ snyk-broker-config integrations create CONNECTIONID ORGID INTEGRATIONID TYPE [APIURL] [APIVERSION] [--json]
    [--log-level debug|warn|error|info|trace]

ARGUMENTS
  CONNECTIONID   Connection ID
  ORGID          Org ID
  INTEGRATIONID  Integration ID
  TYPE           type
  APIURL         [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION     [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Connections Integrations - Create operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config integrations create CONNECTION_ID ORG_ID INTEGRATION_ID

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config integrations create TENANT_ID INSTALL_ID CONNECTION_ID ORG_ID INTEGRATION_ID

See code: src/commands/integrations/create.ts

snyk-broker-config integrations delete CONNECTIONID ORGID INTEGRATIONID [APIURL] [APIVERSION]

Universal Broker Connections Integrations - Delete operation

USAGE
  $ snyk-broker-config integrations delete CONNECTIONID ORGID INTEGRATIONID [APIURL] [APIVERSION] [--json] [--log-level
    debug|warn|error|info|trace]

ARGUMENTS
  CONNECTIONID   Connection ID
  ORGID          Org ID
  INTEGRATIONID  Integration ID
  APIURL         [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION     [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Connections Integrations - Delete operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config integrations delete CONNECTION_ID ORG_ID INTEGRATION_ID

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config integrations delete TENANT_ID INSTALL_ID CONNECTION_ID ORG_ID INTEGRATION_ID

See code: src/commands/integrations/delete.ts

snyk-broker-config integrations list CONNECTIONID [APIURL] [APIVERSION]

Universal Broker Connections Integrations - List operation

USAGE
  $ snyk-broker-config integrations list CONNECTIONID [APIURL] [APIVERSION] [--json] [--log-level
    debug|warn|error|info|trace]

ARGUMENTS
  CONNECTIONID  Connection ID
  APIURL        [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION    [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker Connections Integrations - List operation

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config integrations list CONNECTION_ID

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config integrations list TENANT_ID INSTALL_ID CONNECTION_ID

See code: src/commands/integrations/list.ts

snyk-broker-config introduction

Universal Broker - Introduction

USAGE
  $ snyk-broker-config introduction [--json] [--log-level debug|warn|error|info|trace]

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Introduction

EXAMPLES
  $ snyk-broker-config introduction

See code: src/commands/introduction/index.ts

snyk-broker-config plugins

List installed plugins.

USAGE
  $ snyk-broker-config plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ snyk-broker-config plugins

See code: @oclif/plugin-plugins

snyk-broker-config plugins add PLUGIN

Installs a plugin into snyk-broker-config.

USAGE
  $ snyk-broker-config plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into snyk-broker-config.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the SNYK_BROKER_CONFIG_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the SNYK_BROKER_CONFIG_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ snyk-broker-config plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ snyk-broker-config plugins add myplugin

  Install a plugin from a github url.

    $ snyk-broker-config plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ snyk-broker-config plugins add someuser/someplugin

snyk-broker-config plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ snyk-broker-config 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
  $ snyk-broker-config plugins inspect myplugin

See code: @oclif/plugin-plugins

snyk-broker-config plugins install PLUGIN

Installs a plugin into snyk-broker-config.

USAGE
  $ snyk-broker-config plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into snyk-broker-config.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the SNYK_BROKER_CONFIG_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the SNYK_BROKER_CONFIG_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ snyk-broker-config plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ snyk-broker-config plugins install myplugin

  Install a plugin from a github url.

    $ snyk-broker-config plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ snyk-broker-config plugins install someuser/someplugin

See code: @oclif/plugin-plugins

snyk-broker-config plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ snyk-broker-config plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

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
  $ snyk-broker-config plugins link myplugin

See code: @oclif/plugin-plugins

snyk-broker-config plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ snyk-broker-config plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ snyk-broker-config plugins unlink
  $ snyk-broker-config plugins remove

EXAMPLES
  $ snyk-broker-config plugins remove myplugin

snyk-broker-config plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ snyk-broker-config plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

snyk-broker-config plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ snyk-broker-config plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ snyk-broker-config plugins unlink
  $ snyk-broker-config plugins remove

EXAMPLES
  $ snyk-broker-config plugins uninstall myplugin

See code: @oclif/plugin-plugins

snyk-broker-config plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ snyk-broker-config plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ snyk-broker-config plugins unlink
  $ snyk-broker-config plugins remove

EXAMPLES
  $ snyk-broker-config plugins unlink myplugin

snyk-broker-config plugins update

Update installed plugins.

USAGE
  $ snyk-broker-config plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

snyk-broker-config version

USAGE
  $ snyk-broker-config version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

snyk-broker-config workflows connections create [APIURL] [APIVERSION]

Universal Broker - Create Connection Workflow

USAGE
  $ snyk-broker-config workflows connections create [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Create Connection Workflow

EXAMPLES
  $ snyk-broker-config workflows connections create

See code: src/commands/workflows/connections/create.ts

snyk-broker-config workflows connections delete [APIURL] [APIVERSION]

Universal Broker - Delete Connection Workflow

USAGE
  $ snyk-broker-config workflows connections delete [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker -  Delete Connection Workflow

EXAMPLES
  $ snyk-broker-config workflows connections delete

See code: src/commands/workflows/connections/delete.ts

snyk-broker-config workflows connections disconnect [APIURL] [APIVERSION]

Universal Broker - Connection Disconnect Integration(s) Workflow

USAGE
  $ snyk-broker-config workflows connections disconnect [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker -  Connection Disconnect Integration(s) Workflow

EXAMPLES
  $ snyk-broker-config workflows connections disconnect

See code: src/commands/workflows/connections/disconnect.ts

snyk-broker-config workflows connections get [APIURL] [APIVERSION]

Universal Broker - Get Connection Workflow

USAGE
  $ snyk-broker-config workflows connections get [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Get Connection Workflow

EXAMPLES
  $ snyk-broker-config workflows connections get

See code: src/commands/workflows/connections/get.ts

snyk-broker-config workflows connections integrate [APIURL] [APIVERSION]

Universal Broker - Connection Create Integration(s) Workflow

USAGE
  $ snyk-broker-config workflows connections integrate [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Connection Create Integration(s) Workflow

EXAMPLES
  $ snyk-broker-config workflows connections integrate

See code: src/commands/workflows/connections/integrate.ts

snyk-broker-config workflows connections migrate [APIURL] [APIVERSION]

Universal Broker - Existing Connection Migration Workflow

USAGE
  $ snyk-broker-config workflows connections migrate [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Existing Connection Migration Workflow

EXAMPLES
  $ snyk-broker-config workflows connections migrate

See code: src/commands/workflows/connections/migrate.ts

snyk-broker-config workflows credentials create [APIURL] [APIVERSION]

Universal Broker - Create Credentials Workflow

USAGE
  $ snyk-broker-config workflows credentials create [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Create Credentials Workflow

EXAMPLES
  $ snyk-broker-config workflows credentials create

See code: src/commands/workflows/credentials/create.ts

snyk-broker-config workflows credentials delete [APIURL] [APIVERSION]

Universal Broker - Credentials Deletion Workflow

USAGE
  $ snyk-broker-config workflows credentials delete [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker -  Credentials Deletion Workflow

EXAMPLES
  [with exported TENANT_ID,INSTALL_ID]

  $ snyk-broker-config workflows credentials delete

  [inline TENANT_ID,INSTALL_ID]

  $ snyk-broker-config workflows credentials delete TENANT_ID INSTALL_ID

See code: src/commands/workflows/credentials/delete.ts

snyk-broker-config workflows credentials get [APIURL] [APIVERSION]

Universal Broker - Get Credentials Workflow

USAGE
  $ snyk-broker-config workflows credentials get [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Get Credentials Workflow

EXAMPLES
  $ snyk-broker-config workflows credentials get

See code: src/commands/workflows/credentials/get.ts

snyk-broker-config workflows deployments create [APIURL] [APIVERSION]

Universal Broker - Create Deployment Workflow

USAGE
  $ snyk-broker-config workflows deployments create [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Create Deployment Workflow

EXAMPLES
  $ snyk-broker-config workflows deployments create

See code: src/commands/workflows/deployments/create.ts

snyk-broker-config workflows deployments delete [APIURL] [APIVERSION]

Universal Broker - Delete Deployment workflow

USAGE
  $ snyk-broker-config workflows deployments delete [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker -  Delete Deployment workflow

EXAMPLES
  $ snyk-broker-config workflows deployments delete

See code: src/commands/workflows/deployments/delete.ts

snyk-broker-config workflows deployments get [APIURL] [APIVERSION]

Universal Broker - Get Deployments Workflow

USAGE
  $ snyk-broker-config workflows deployments get [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Get Deployments Workflow

EXAMPLES
  $ snyk-broker-config workflows deployments get

See code: src/commands/workflows/deployments/get.ts

snyk-broker-config workflows deployments update [APIURL] [APIVERSION]

Universal Broker - Update Deployment Workflow

USAGE
  $ snyk-broker-config workflows deployments update [APIURL] [APIVERSION] [--json] [--log-level
  debug|warn|error|info|trace]

ARGUMENTS
  APIURL      [default: https://api.pre-prod.snyk.io] API Url
  APIVERSION  [default: 2024-02-08~experimental] API Version

GLOBAL FLAGS
  --json                Format output as json.
  --log-level=<option>  [default: info] Specify level for logging.
                        <options: debug|warn|error|info|trace>

DESCRIPTION
  Universal Broker - Update Deployment Workflow

EXAMPLES
  $ snyk-broker-config workflows deployments update

See code: src/commands/workflows/deployments/update.ts

About

Small CLI utility for Snyk Universal Broker

Resources

License

Security policy

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages