{"id":27890185,"url":"https://github.com/tibcosoftware/cic-cli-plugin-tcam","last_synced_at":"2025-05-05T10:44:56.972Z","repository":{"id":42634103,"uuid":"459207415","full_name":"TIBCOSoftware/cic-cli-plugin-tcam","owner":"TIBCOSoftware","description":null,"archived":false,"fork":false,"pushed_at":"2023-07-19T19:50:59.000Z","size":861,"stargazers_count":8,"open_issues_count":7,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-28T01:05:17.332Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TIBCOSoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-14T15:02:53.000Z","updated_at":"2022-11-14T12:55:45.000Z","dependencies_parsed_at":"2023-02-08T16:16:15.324Z","dependency_job_id":null,"html_url":"https://github.com/TIBCOSoftware/cic-cli-plugin-tcam","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TIBCOSoftware%2Fcic-cli-plugin-tcam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TIBCOSoftware%2Fcic-cli-plugin-tcam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TIBCOSoftware%2Fcic-cli-plugin-tcam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TIBCOSoftware%2Fcic-cli-plugin-tcam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TIBCOSoftware","download_url":"https://codeload.github.com/TIBCOSoftware/cic-cli-plugin-tcam/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252485557,"owners_count":21755817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-05T10:44:56.149Z","updated_at":"2025-05-05T10:44:56.964Z","avatar_url":"https://github.com/TIBCOSoftware.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":" CLI Plugin for TIBCO Cloud™ API Modeler \n===================\n\nThis 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.\n\n\u003c!-- toc --\u003e\n* [Usage](#usage)\n* [Commands](#commands)\n\u003c!-- tocstop --\u003e\n\n\nA detailed [step-by-step walkthrough for the CLI plugin usage is available here.](https://www.walkthrough.so/pblc/QPaTYNPVOfUP/cli-plugin-for-tibco-cloud-tm-api-modeler?usp=sharing)\n\n# Usage\nInstall 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.\n```sh-session\n Install TCAM CLI Plugin\n   $ tibco plugins:install @tibco-software/cli-plugin-tcam\n \n USAGE\n  $ tibco tcam:COMMAND\n```\n# Commands\n\u003c!-- commands --\u003e\n* [`tibco tcam:create-project`](#tibco-tcamcreate-project)\n* [`tibco tcam:export-apis`](#tibco-tcamexport-apis)\n* [`tibco tcam:generate-mock`](#tibco-tcamgenerate-mock)\n* [`tibco tcam:import-apis`](#tibco-tcamimport-apis)\n* [`tibco tcam:list-apis`](#tibco-tcamlist-apis)\n* [`tibco tcam:list-projects`](#tibco-tcamlist-projects)\n* [`tibco tcam:validate-apis`](#tibco-tcamvalidate-apis)\n\n## `tibco tcam:create-project`\n\nCreate a project\n\n```\nUSAGE\n  $ tibco tcam:create-project\n\nOPTIONS\n  -f, --force\n  -h, --help         show CLI help\n  -n, --name=name    (required) Specify a project name\n  --config=config    Path to the local config file\n  --no-warnings      Disable warnings from command's output\n  --profile=profile  Switch to different org or region using profile\n\nEXAMPLES\n  tibco tcam:create-project --name \"Cli Project\"\n  tibco tcam:create-project -n \"Cli Project\"\n```\n\n_See code: [src/commands/tcam/create-project.ts](https://github.com/TIBCOSoftware/cic-cli-plugin-tcam/blob/v1.0.2/src/commands/tcam/create-project.ts)_\n\n## `tibco tcam:export-apis`\n\nExport APIs to a local file system\n\n```\nUSAGE\n  $ tibco tcam:export-apis\n\nOPTIONS\n  -a, --apinames=apinames        Specify APIs to export by name\n  -f, --force\n  -h, --help                     show CLI help\n  -p, --projectname=projectname  (required) Export APIs for the specified project\n  -y, --yaml                     Export APIs in YAML format\n  --config=config                Path to the local config file\n  --no-warnings                  Disable warnings from command's output\n  --profile=profile              Switch to different org or region using profile\n\nEXAMPLES\n  tibco tcam:export-apis --projectname \"Cli Project\"\n  tibco tcam:export-apis --projectname \"Cli Project\" --apinames 'InvalidApi,CliOpenApi\" --yaml\n  tibco tcam:export-apis -p \"Cli Project\" -a \"InvalidApi,CliOpenApi\" -y\n```\n\n_See code: [src/commands/tcam/export-apis.ts](https://github.com/TIBCOSoftware/cic-cli-plugin-tcam/blob/v1.0.2/src/commands/tcam/export-apis.ts)_\n\n## `tibco tcam:generate-mock`\n\nGenerate a NodeJS mock app\n\n```\nUSAGE\n  $ tibco tcam:generate-mock\n\nOPTIONS\n  -a, --api=api          Specify the API to be pulled from the API modeler\n  -d, --deploy           Deploy the generated app on TCI\n  -f, --from=from        Specify the JSON/YAML file path of an OpenAPI spec\n  -h, --help             show CLI help\n  -n, --name=name        App name\n  -p, --project=project  Specify project name\n  -s, --static           Generate static response rather than dynamic\n  -v, --version=version  Specify the API version\n  --config=config        Path to the local config file\n  --no-warnings          Disable warnings from command's output\n  --profile=profile      Switch to different org or region using profile\n\nEXAMPLES\n  tibco tcam:generate-mock --from \"C:/Users/myuser/Desktop/Upload/ImportApi.json\" --deploy --static\n  tibco tcam:generate-mock --project NodeProj --api Petstore --deploy\n  tibco tcam:generate-mock -f \"C:/Users/myuser/Desktop/Upload/ImportApi.json\" -d -s\n```\n\n_See code: [src/commands/tcam/generate-mock.ts](https://github.com/TIBCOSoftware/cic-cli-plugin-tcam/blob/v1.0.2/src/commands/tcam/generate-mock.ts)_\n\n## `tibco tcam:import-apis`\n\nImport API specs\n\n```\nUSAGE\n  $ tibco tcam:import-apis\n\nOPTIONS\n  -f, --from=from                (required) Specify the location of an API spec or directory\n  -h, --help                     show CLI help\n  -n, --newproject=yes           Specify to create new project if it doesn't exist in the organization\n\n  -p, --projectname=projectname  (required) Specify the target project name for the API import. The project must exist\n                                 in the organization.\n\n  --config=config                Path to the local config file\n\n  --no-warnings                  Disable warnings from command's output\n\n  --profile=profile              Switch to different org or region using profile\n\nEXAMPLES\n  tibco tcam:import-apis --from 'C:/Users/myuser/Desktop/Upload/ImportApi.json' --projectname 'TestProject'\n  tibco tcam:import-apis -f 'C:/Users/myuser/Desktop/Upload/ImportProject' -p 'TestProject'\n```\n\n_See code: [src/commands/tcam/import-apis.ts](https://github.com/TIBCOSoftware/cic-cli-plugin-tcam/blob/v1.0.2/src/commands/tcam/import-apis.ts)_\n\n## `tibco tcam:list-apis`\n\nList APIs\n\n```\nUSAGE\n  $ tibco tcam:list-apis\n\nOPTIONS\n  -a, --apinames=apinames          Specify API names\n  -f, --force\n  -h, --help                       show CLI help\n  -p, --projectnames=projectnames  Specify project names\n  -t, --apitypes=apitypes          API types you want to list. For example openapi,asyncapi\n  --config=config                  Path to the local config file\n  --no-warnings                    Disable warnings from command's output\n  --profile=profile                Switch to different org or region using profile\n\nEXAMPLES\n  tibco tcam:list-apis\n  tibco tcam:list-apis --projectnames \"Cli Project\"\n  tibco tcam:list-apis --projectnames \"Cli Project,AuthProject\"\n  tibco tcam:list-apis --apitypes \"openapi\"\n  tibco tcam:list-apis -p \"AuthProject\" -t \"openapi\"\n  tibco tcam:list-apis --apinames \"CliAsyncApi,CliOpenApi\"\n```\n\n_See code: [src/commands/tcam/list-apis.ts](https://github.com/TIBCOSoftware/cic-cli-plugin-tcam/blob/v1.0.2/src/commands/tcam/list-apis.ts)_\n\n## `tibco tcam:list-projects`\n\nList projects\n\n```\nUSAGE\n  $ tibco tcam:list-projects\n\nOPTIONS\n  -f, --force\n  -h, --help                       show CLI help\n  -p, --projectnames=projectnames  Specify project names\n  --config=config                  Path to the local config file\n  --no-warnings                    Disable warnings from command's output\n  --profile=profile                Switch to different org or region using profile\n\nEXAMPLES\n  tibco tcam:list-projects\n  tibco tcam:list-projects --projectnames \"Cli Project, UI Project\"\n  tibco tcam:list-projects -p \"Cli Project, UI Project\"\n```\n\n_See code: [src/commands/tcam/list-projects.ts](https://github.com/TIBCOSoftware/cic-cli-plugin-tcam/blob/v1.0.2/src/commands/tcam/list-projects.ts)_\n\n## `tibco tcam:validate-apis`\n\nValidate API specs\n\n```\nUSAGE\n  $ tibco tcam:validate-apis\n\nOPTIONS\n  -a, --apinames=apinames  API names that need to be validated from the directory\n  -f, --from=from          (required) Specify the location of an API spec or directory\n  -h, --help               show CLI help\n  --config=config          Path to the local config file\n  --no-warnings            Disable warnings from command's output\n  --profile=profile        Switch to different org or region using profile\n\nEXAMPLES\n  tibco tcam:validate-apis --from \"C:/Users/myuser/Desktop/Upload/ImportApi.json\"\n  tibco tcam:validate-apis -f \"C:/Users/myuser/Desktop/Upload/ImportProject\"\n  tibco tcam:validate-apis --from \"C:/Users/myuser/Desktop/Upload/ImportProject\" --apinames \"bankapi,yamlapi\"\n  tibco tcam:validate-apis -f \"C:/Users/myuser/Desktop/Upload/ImportProject\" -a \"bankapi,yamlapi\"\n```\n\n_See code: [src/commands/tcam/validate-apis.ts](https://github.com/TIBCOSoftware/cic-cli-plugin-tcam/blob/v1.0.2/src/commands/tcam/validate-apis.ts)_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftibcosoftware%2Fcic-cli-plugin-tcam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftibcosoftware%2Fcic-cli-plugin-tcam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftibcosoftware%2Fcic-cli-plugin-tcam/lists"}