Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@tibco-software/cli-plugin-tcam

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@tibco-software/cli-plugin-tcam

CLI Plugin for TIBCO Cloud™ API Modeler ===================

1.1.0
latest
Source
npm

Version published: 2 years ago

Maintainers: 6

Created: 3 years ago

Source

CLI Plugin for TIBCO Cloud™ API Modeler

This is a CLI Plugin which will provide you the ability to run basic commands for TIBCO Cloud API Modeler features via the command line interface.

A detailed step-by-step walkthrough for the CLI plugin usage is available here.

Usage

Install CLI Main by following step #1 (i to v) from the instructions provided at https://github.com/TIBCOSoftware/cic-cli-main under the Installation topic.

 Install TCAM CLI Plugin
   $ tibco plugins:install @tibco-software/cli-plugin-tcam
 
 USAGE
  $ tibco tcam:COMMAND

Commands

`tibco tcam:create-project`

Create a project

USAGE
  $ tibco tcam:create-project

OPTIONS
  -f, --force
  -h, --help         show CLI help
  -n, --name=name    (required) Specify a project name
  --config=config    Path to the local config file
  --no-warnings      Disable warnings from command's output
  --profile=profile  Switch to different org or region using profile

EXAMPLES
  tibco tcam:create-project --name "Cli Project"
  tibco tcam:create-project -n "Cli Project"

See code: src/commands/tcam/create-project.ts

`tibco tcam:export-apis`

Export APIs to a local file system

USAGE
  $ tibco tcam:export-apis

OPTIONS
  -a, --apinames=apinames        Specify APIs to export by name
  -f, --force
  -h, --help                     show CLI help
  -p, --projectname=projectname  (required) Export APIs for the specified project
  -y, --yaml                     Export APIs in YAML format
  --config=config                Path to the local config file
  --no-warnings                  Disable warnings from command's output
  --profile=profile              Switch to different org or region using profile

EXAMPLES
  tibco tcam:export-apis --projectname "Cli Project"
  tibco tcam:export-apis --projectname "Cli Project" --apinames 'InvalidApi,CliOpenApi" --yaml
  tibco tcam:export-apis -p "Cli Project" -a "InvalidApi,CliOpenApi" -y

See code: src/commands/tcam/export-apis.ts

`tibco tcam:generate-mock`

Generate a NodeJS mock app

USAGE
  $ tibco tcam:generate-mock

OPTIONS
  -a, --api=api          Specify the API to be pulled from the API modeler
  -d, --deploy           Deploy the generated app on TCI
  -f, --from=from        Specify the JSON/YAML file path of an OpenAPI spec
  -h, --help             show CLI help
  -n, --name=name        App name
  -p, --project=project  Specify project name
  -s, --static           Generate static response rather than dynamic
  -v, --version=version  Specify the API version
  --config=config        Path to the local config file
  --no-warnings          Disable warnings from command's output
  --profile=profile      Switch to different org or region using profile

EXAMPLES
  tibco tcam:generate-mock --from "C:/Users/myuser/Desktop/Upload/ImportApi.json" --deploy --static
  tibco tcam:generate-mock --project NodeProj --api Petstore --deploy
  tibco tcam:generate-mock -f "C:/Users/myuser/Desktop/Upload/ImportApi.json" -d -s

See code: src/commands/tcam/generate-mock.ts

`tibco tcam:import-apis`

Import API specs

USAGE
  $ tibco tcam:import-apis

OPTIONS
  -f, --from=from                (required) Specify the location of an API spec or directory
  -h, --help                     show CLI help
  -n, --newproject=yes           Specify to create new project if it doesn't exist in the organization

  -p, --projectname=projectname  (required) Specify the target project name for the API import. The project must exist
                                 in the organization.

  --config=config                Path to the local config file

  --no-warnings                  Disable warnings from command's output

  --profile=profile              Switch to different org or region using profile

EXAMPLES
  tibco tcam:import-apis --from 'C:/Users/myuser/Desktop/Upload/ImportApi.json' --projectname 'TestProject'
  tibco tcam:import-apis -f 'C:/Users/myuser/Desktop/Upload/ImportProject' -p 'TestProject'

See code: src/commands/tcam/import-apis.ts

`tibco tcam:list-apis`

List APIs

USAGE
  $ tibco tcam:list-apis

OPTIONS
  -a, --apinames=apinames          Specify API names
  -f, --force
  -h, --help                       show CLI help
  -p, --projectnames=projectnames  Specify project names
  -t, --apitypes=apitypes          API types you want to list. For example openapi,asyncapi
  --config=config                  Path to the local config file
  --no-warnings                    Disable warnings from command's output
  --profile=profile                Switch to different org or region using profile

EXAMPLES
  tibco tcam:list-apis
  tibco tcam:list-apis --projectnames "Cli Project"
  tibco tcam:list-apis --projectnames "Cli Project,AuthProject"
  tibco tcam:list-apis --apitypes "openapi"
  tibco tcam:list-apis -p "AuthProject" -t "openapi"
  tibco tcam:list-apis --apinames "CliAsyncApi,CliOpenApi"

See code: src/commands/tcam/list-apis.ts

`tibco tcam:list-projects`

List projects

USAGE
  $ tibco tcam:list-projects

OPTIONS
  -f, --force
  -h, --help                       show CLI help
  -p, --projectnames=projectnames  Specify project names
  --config=config                  Path to the local config file
  --no-warnings                    Disable warnings from command's output
  --profile=profile                Switch to different org or region using profile

EXAMPLES
  tibco tcam:list-projects
  tibco tcam:list-projects --projectnames "Cli Project, UI Project"
  tibco tcam:list-projects -p "Cli Project, UI Project"

See code: src/commands/tcam/list-projects.ts

`tibco tcam:validate-apis`

Validate API specs

USAGE
  $ tibco tcam:validate-apis

OPTIONS
  -a, --apinames=apinames  API names that need to be validated from the directory
  -f, --from=from          (required) Specify the location of an API spec or directory
  -h, --help               show CLI help
  --config=config          Path to the local config file
  --no-warnings            Disable warnings from command's output
  --profile=profile        Switch to different org or region using profile

EXAMPLES
  tibco tcam:validate-apis --from "C:/Users/myuser/Desktop/Upload/ImportApi.json"
  tibco tcam:validate-apis -f "C:/Users/myuser/Desktop/Upload/ImportProject"
  tibco tcam:validate-apis --from "C:/Users/myuser/Desktop/Upload/ImportProject" --apinames "bankapi,yamlapi"
  tibco tcam:validate-apis -f "C:/Users/myuser/Desktop/Upload/ImportProject" -a "bankapi,yamlapi"

See code: src/commands/tcam/validate-apis.ts

`tibco tcam:create-project`

Create a project

USAGE
  $ tibco tcam:create-project

OPTIONS
  -f, --force
  -h, --help         show CLI help
  -n, --name=name    (required) Specify a project name
  --config=config    Path to the local config file
  --no-warnings      Disable warnings from command's output
  --profile=profile  Switch to different org or region using profile

EXAMPLES
  tibco tcam:create-project --name "Cli Project"
  tibco tcam:create-project -n "Cli Project"

See code: src/commands/tcam/create-project.ts

`tibco tcam:export-apis`

Export APIs to a local file system

USAGE
  $ tibco tcam:export-apis

OPTIONS
  -a, --apinames=apinames        Specify APIs to export by name
  -f, --force
  -h, --help                     show CLI help
  -p, --projectname=projectname  (required) Export APIs for the specified project
  -y, --yaml                     Export APIs in YAML format
  --config=config                Path to the local config file
  --no-warnings                  Disable warnings from command's output
  --profile=profile              Switch to different org or region using profile

EXAMPLES
  tibco tcam:export-apis --projectname "Cli Project"
  tibco tcam:export-apis --projectname "Cli Project" --apinames 'InvalidApi,CliOpenApi" --yaml
  tibco tcam:export-apis -p "Cli Project" -a "InvalidApi,CliOpenApi" -y

See code: src/commands/tcam/export-apis.ts

`tibco tcam:generate-mock`

Generate a NodeJS mock app

USAGE
  $ tibco tcam:generate-mock

OPTIONS
  -a, --api=api          Specify the API to be pulled from the API modeler
  -d, --deploy           Deploy the generated app on TCI
  -f, --from=from        Specify the JSON/YAML file path of an OpenAPI spec
  -h, --help             show CLI help
  -n, --name=name        App name
  -p, --project=project  Specify project name
  -s, --static           Generate static response rather than dynamic
  -v, --version=version  Specify the API version
  --config=config        Path to the local config file
  --no-warnings          Disable warnings from command's output
  --profile=profile      Switch to different org or region using profile

EXAMPLES
  tibco tcam:generate-mock --from "C:/Users/myuser/Desktop/Upload/ImportApi.json" --deploy --static
  tibco tcam:generate-mock --project NodeProj --api Petstore --deploy
  tibco tcam:generate-mock -f "C:/Users/myuser/Desktop/Upload/ImportApi.json" -d -s

See code: src/commands/tcam/generate-mock.ts

`tibco tcam:import-apis`

Import API specs

USAGE
  $ tibco tcam:import-apis

OPTIONS
  -f, --from=from                (required) Specify the location of an API spec or directory
  -h, --help                     show CLI help
  -n, --newproject=yes           Specify to create new project if it doesn't exist in the organization

  -p, --projectname=projectname  (required) Specify the target project name for the API import. The project must exist
                                 in the organization.

  --config=config                Path to the local config file

  --no-warnings                  Disable warnings from command's output

  --profile=profile              Switch to different org or region using profile

EXAMPLES
  tibco tcam:import-apis --from 'C:/Users/myuser/Desktop/Upload/ImportApi.json' --projectname 'TestProject'
  tibco tcam:import-apis -f 'C:/Users/myuser/Desktop/Upload/ImportProject' -p 'TestProject'

See code: src/commands/tcam/import-apis.ts

`tibco tcam:list-apis`

List APIs

USAGE
  $ tibco tcam:list-apis

OPTIONS
  -a, --apinames=apinames          Specify API names
  -f, --force
  -h, --help                       show CLI help
  -p, --projectnames=projectnames  Specify project names
  -t, --apitypes=apitypes          API types you want to list. For example openapi,asyncapi
  --config=config                  Path to the local config file
  --no-warnings                    Disable warnings from command's output
  --profile=profile                Switch to different org or region using profile

EXAMPLES
  tibco tcam:list-apis
  tibco tcam:list-apis --projectnames "Cli Project"
  tibco tcam:list-apis --projectnames "Cli Project,AuthProject"
  tibco tcam:list-apis --apitypes "openapi"
  tibco tcam:list-apis -p "AuthProject" -t "openapi"
  tibco tcam:list-apis --apinames "CliAsyncApi,CliOpenApi"

See code: src/commands/tcam/list-apis.ts

`tibco tcam:list-projects`

List projects

USAGE
  $ tibco tcam:list-projects

OPTIONS
  -f, --force
  -h, --help                       show CLI help
  -p, --projectnames=projectnames  Specify project names
  --config=config                  Path to the local config file
  --no-warnings                    Disable warnings from command's output
  --profile=profile                Switch to different org or region using profile

EXAMPLES
  tibco tcam:list-projects
  tibco tcam:list-projects --projectnames "Cli Project, UI Project"
  tibco tcam:list-projects -p "Cli Project, UI Project"

See code: src/commands/tcam/list-projects.ts

`tibco tcam:validate-apis`

Validate API specs

USAGE
  $ tibco tcam:validate-apis

OPTIONS
  -a, --apinames=apinames  API names that need to be validated from the directory
  -f, --from=from          (required) Specify the location of an API spec or directory
  -h, --help               show CLI help
  --config=config          Path to the local config file
  --no-warnings            Disable warnings from command's output
  --profile=profile        Switch to different org or region using profile

EXAMPLES
  tibco tcam:validate-apis --from "C:/Users/myuser/Desktop/Upload/ImportApi.json"
  tibco tcam:validate-apis -f "C:/Users/myuser/Desktop/Upload/ImportProject"
  tibco tcam:validate-apis --from "C:/Users/myuser/Desktop/Upload/ImportProject" --apinames "bankapi,yamlapi"
  tibco tcam:validate-apis -f "C:/Users/myuser/Desktop/Upload/ImportProject" -a "bankapi,yamlapi"

See code: src/commands/tcam/validate-apis.ts

Keywords

FAQs

What is @tibco-software/cli-plugin-tcam?

Is @tibco-software/cli-plugin-tcam well maintained?

Package last updated on 26 Jul 2022

Did you know?

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

@tibco-software/cli-plugin-tcam

CLI Plugin for TIBCO Cloud™ API Modeler

Usage

Commands

tibco tcam:create-project

tibco tcam:export-apis

tibco tcam:generate-mock

tibco tcam:import-apis

tibco tcam:list-apis

tibco tcam:list-projects

tibco tcam:validate-apis

tibco tcam:create-project

tibco tcam:export-apis

tibco tcam:generate-mock

tibco tcam:import-apis

tibco tcam:list-apis

tibco tcam:list-projects

tibco tcam:validate-apis

Keywords

Related posts

Malicious npm Package Typosquats Popular TypeScript ESLint Plugin, Exfiltrates Data and Enables Remote Exploitation

Ultralytics PyPI Package Compromised Through GitHub Actions Cache Poisoning

`tibco tcam:create-project`

`tibco tcam:export-apis`

`tibco tcam:generate-mock`

`tibco tcam:import-apis`

`tibco tcam:list-apis`

`tibco tcam:list-projects`

`tibco tcam:validate-apis`

`tibco tcam:create-project`

`tibco tcam:export-apis`

`tibco tcam:generate-mock`

`tibco tcam:import-apis`

`tibco tcam:list-apis`

`tibco tcam:list-projects`

`tibco tcam:validate-apis`