UNPKG

pmac

Version:

Manages your team's Postman as code.

1 lines 30 kB
{"version":"1.4.0","commands":{"collection:create":{"id":"collection:create","description":"Creates a new PM collection out of your service OpenApi V3 (swagger) specification.","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$ pmac collection create --open-api ./path/to/your/open-api-v3-spec.yml\n","$ pmac collection create -o ./path/to/your/open-api-v3-spec.yml\n"],"flags":{"open-api":{"name":"open-api","type":"option","char":"o","description":"Path to your OpenApi V3 (known as swagger) specification","required":true,"helpValue":"./path/to/your/openapi.yml","multiple":false},"workspace":{"name":"workspace","type":"option","char":"w","description":"Path to the required workspace","required":false,"multiple":false}},"args":[]},"collection:delete":{"id":"collection:delete","description":"Deletes PM collection. default: Deletes from both .pmac (repository), and PM account (remote).","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac collection delete\n"],"flags":{"pm-only":{"name":"pm-only","type":"boolean","char":"r","description":"Removes collection only from your PM account, keeps workspace in .pmac (repository)","required":false,"allowNo":false},"pmac-only":{"name":"pmac-only","type":"boolean","char":"l","description":"Removes collection only from .pmac, keeps workspace in your PM account (remote)","required":false,"allowNo":false}},"args":[]},"collection:pull":{"id":"collection:pull","description":"Pulls (Fetches) new updates about an existing collection on your .pmac (repository).","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac collection pull\n"],"flags":{},"args":[]},"collection:push":{"id":"collection:push","description":"Pulls (Fetches) new updates about an existing collection on your .pmac (repository).","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac collection pull\n"],"flags":{},"args":[]},"collection:run":{"id":"collection:run","description":"Using `newman run` behind-the-scenes to initiate a Postman Collection run from a given URL or path","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac collection run\n","pmac collection run --environment ./.pmac/workspaces/personal/my-workspace/environments/my-environment.postman_environment.json\n","pmac collection run --skip-environment\n","pmac collection run --collection ./.pmac/workspaces/personal/my-workspace/collections/my-collection.postman_collection.json\n"],"flags":{"globals":{"name":"globals","type":"option","char":"g","description":"Specify a URL or path to a file\n containing Postman Globals","helpValue":"<path>","multiple":false},"iteration-count":{"name":"iteration-count","type":"option","char":"n","description":"Define the number of iterations to run (default: 1)","required":false,"helpValue":"<n>","multiple":false,"default":1},"iteration-data":{"name":"iteration-data","type":"option","char":"d","description":"Specify a data file to use for\n iterations (either JSON or CSV)","helpValue":"<path>","multiple":false},"folder":{"name":"folder","type":"option","description":"Specify the folder to run from a collection. Can be specified multiple times to run multiple folders (default: [])","helpValue":"<path>","multiple":true,"default":[]},"global-var":{"name":"global-var","type":"option","description":"Allows the specification of global\n variables via the command line, in a\n key=value format (default: [])","helpValue":"<value>","helpGroup":"iniline environment variables","multiple":false},"env-var":{"name":"env-var","type":"boolean","description":"Allows the specification of environment\n variables via .env file, watching for \"PMAC_\" environment variables, \n cut its prefix and set them as camelcase.\n Default takes \".env\", if you wish to customize it, use \"env-var-path\" flag.","helpGroup":"fundamentals","allowNo":false},"env-var-path":{"name":"env-var-path","type":"option","description":"A custom relative path to your .env file","helpValue":"<my/custom/dotenv/path/.env","helpGroup":"fundamentals","multiple":false},"export-environment":{"name":"export-environment","type":"option","description":"Exports the final environment to a file\n after completing the run","helpValue":"<path>","helpGroup":"export","multiple":false},"export-globals":{"name":"export-globals","type":"option","description":"Exports the final globals to a file\n after completing the run","helpValue":"<path>","helpGroup":"export","multiple":false},"export-collection":{"name":"export-collection","type":"option","description":"Exports the executed collection to a\n file after completing the run","helpValue":"<path>","helpGroup":"export","multiple":false},"postman-api-key":{"name":"postman-api-key","type":"option","description":"API Key used to load the resources from\n the Postman API","helpValue":"<apiKey>","helpGroup":"security","multiple":false},"bail":{"name":"bail","type":"option","description":"Specify whether or not to gracefully\n stop a collection run on encountering\n an error and whether to end the run\n with an error based on the optional\n modifier","helpValue":"[modifiers]","multiple":false},"ignore-redirects":{"name":"ignore-redirects","type":"boolean","description":"Prevents Newman from automatically\n following 3XX redirect responses","helpGroup":"security","allowNo":false},"suppress-exit-code":{"name":"suppress-exit-code","type":"boolean","char":"x","description":"Specify whether or not to override the\n default exit code for the current run","allowNo":false},"silent":{"name":"silent","type":"boolean","description":"Prevents Newman from showing output to CLI","allowNo":false},"disable-unicode":{"name":"disable-unicode","type":"boolean","description":"Forces Unicode compliant symbols to be\n replaced by their plain text\n equivalents","helpGroup":"security","allowNo":false},"color":{"name":"color","type":"option","description":"Enable/Disable colored output\n (auto|on|off) (default: \"auto\")","helpValue":"(auto|on|off)","multiple":false,"options":["auto","on","off"],"default":"auto"},"delay-request":{"name":"delay-request","type":"option","description":"Specify the extent of delay between\n requests (milliseconds) (default: 0)","helpValue":"[n]","helpGroup":"times","multiple":false,"default":0},"timeout":{"name":"timeout","type":"option","description":"Specify a timeout for collection run\n (milliseconds) (default: 0)","helpValue":"[n]","helpGroup":"times","multiple":false,"default":0},"timeout-request":{"name":"timeout-request","type":"option","description":"Specify a timeout for requests\n (milliseconds) (default: 0)","helpValue":"[n]","helpGroup":"times","multiple":false,"default":0},"timeout-script":{"name":"timeout-script","type":"option","description":"Specify a timeout for scripts\n (milliseconds) (default: 0)","helpValue":"[n]","helpGroup":"times","multiple":false,"default":0},"working-dir":{"name":"working-dir","type":"option","description":"Specify the path to the working\n directory","helpValue":"<path>","multiple":false},"no-insecure-file-read":{"name":"no-insecure-file-read","type":"boolean","description":"Prevents reading the files situated\n outside of the working directory","helpGroup":"security","allowNo":false},"insecure":{"name":"insecure","type":"boolean","char":"k","description":"Disables SSL validations","helpGroup":"security","allowNo":false},"ssl-client-cert-list":{"name":"ssl-client-cert-list","type":"option","description":"Specify the path to a client\n certificates configurations (JSON)","helpValue":"<path>","helpGroup":"security","multiple":false},"ssl-client-cert":{"name":"ssl-client-cert","type":"option","description":"Specify the path to a client\n certificate private key","helpValue":"<path>","helpGroup":"security","multiple":false},"ssl-client-key":{"name":"ssl-client-key","type":"option","description":"Specify the path to a client\n certificate private key","helpValue":"<path>","helpGroup":"security","multiple":false},"ssl-client-passphrase":{"name":"ssl-client-passphrase","type":"option","description":"Specify the client certificate\n passphrase (for protected key)","helpValue":"<passphrase>","helpGroup":"security","multiple":false},"ssl-extra-ca-certs":{"name":"ssl-extra-ca-certs","type":"option","description":"Specify additionally trusted CA\n certificates (PEM)","helpValue":"<path>","helpGroup":"security","multiple":false},"cookie-jar":{"name":"cookie-jar","type":"option","description":"Specify the path to a custom cookie jar\n (serialized tough-cookie JSON)","helpValue":"<path>","helpGroup":"security","multiple":false},"export-cookie-jar":{"name":"export-cookie-jar","type":"option","description":"Exports the cookie jar to a file after\n completing the run","helpValue":"<path>","helpGroup":"security","multiple":false},"verbose":{"name":"verbose","type":"boolean","description":"Show detailed information of collection\n run and each request sent","allowNo":false},"skip-environment":{"name":"skip-environment","type":"boolean","description":"Skips choosing an environment","allowNo":false},"environment":{"name":"environment","type":"option","char":"e","description":"Specify a URL or path to a Postman Environment, If you wish to skip environment pick, use \"skip-environment flag\"","required":false,"helpValue":"<source>","multiple":false,"default":""},"collection":{"name":"collection","type":"option","char":"c","description":"Relative path to your .pmac collection defined JSON","required":false,"multiple":false,"default":""},"reporters":{"name":"reporters","type":"option","char":"r","description":"Specify in comma separated format the reporters to use for this run (default: [\"cli\"])","required":false,"helpValue":"cli,htmlextra","multiple":false,"options":["cli","html","csv","junit","htmlextra"],"default":"cli"},"no-summary":{"name":"no-summary","type":"boolean","description":"The statistical summary table is not shown.","helpGroup":"CLI reporter","allowNo":false},"reporter-no-summary":{"name":"reporter-no-summary","type":"boolean","description":"The statistical summary table is not shown.","helpGroup":"CLI reporter","allowNo":false},"reporter-cli-no-summary":{"name":"reporter-cli-no-summary","type":"boolean","description":"The statistical summary table is not shown.","helpGroup":"CLI reporter","allowNo":false},"reporter-cli-silent":{"name":"reporter-cli-silent","type":"boolean","description":"The CLI reporter is internally disabled and you see no output to terminal.","helpGroup":"CLI reporter","allowNo":false},"reporter-cli-show-timestamps":{"name":"reporter-cli-show-timestamps","type":"boolean","description":"This prints the local time for each request made.","helpGroup":"CLI reporter","allowNo":false},"reporter-cli-no-failures":{"name":"reporter-cli-no-failures","type":"boolean","description":"This prevents the run failures from being separately printed.","helpGroup":"CLI reporter","allowNo":false},"reporter-cli-no-assertions":{"name":"reporter-cli-no-assertions","type":"boolean","description":"This turns off the output for request-wise assertions as they happen.","helpGroup":"CLI reporter","allowNo":false},"reporter-cli-no-success-assertions":{"name":"reporter-cli-no-success-assertions","type":"boolean","description":"This turns off the output for successful assertions as they happen.","helpGroup":"CLI reporter","allowNo":false},"reporter-cli-no-console":{"name":"reporter-cli-no-console","type":"boolean","description":"This turns off the output of console.log (and other console calls) from collection's scripts.","helpGroup":"CLI reporter","allowNo":false},"reporter-cli-no-banner":{"name":"reporter-cli-no-banner","type":"boolean","description":"This turns off the newman banner shown at the beginning of each collection run.","helpGroup":"CLI reporter","allowNo":false},"reporter-json-export":{"name":"reporter-json-export","type":"option","description":"Specify a path where the output JSON file will be written to disk. If not specified, the file will be written to newman/ in the current working directory. If the specified path does not exist, it will be created. However, if the specified path is a pre-existing directory, the report will be generated in that directory.","helpValue":"<path>","helpGroup":"JSON reporter","multiple":false},"reporter-junit-export":{"name":"reporter-junit-export","type":"option","description":"Specify a path where the output XML file will be written to disk. If not specified, the file will be written to newman/ in the current working directory. If the specified path does not exist, it will be created. However, if the specified path is a pre-existing directory, the report will be generated in that directory.","helpValue":"<path>","helpGroup":"junit reporter","multiple":false},"reporter-html-export":{"name":"reporter-html-export","type":"option","description":"Specify a path where the output HTML file will be written to disk. If not specified, the file will be written to newman/ in the current working directory.","helpValue":"<path>","helpGroup":"HTML reporter","multiple":false},"reporter-html-template":{"name":"reporter-html-template","type":"option","description":"Specify a path to the custom template which will be used to render the HTML report. This option depends on --reporter html and --reporter-html-export being present in the run command. If this option is not specified, the default template is used","helpValue":"<path>","helpGroup":"HTML reporter","multiple":false},"reporter-htmlextra-export":{"name":"reporter-htmlextra-export","type":"option","description":"Specify a path where the output HTML file will be written to disk. If not specified, the file will be written to newman/ in the current working directory.","helpValue":"<path>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-template":{"name":"reporter-htmlextra-template","type":"option","description":"Specify a path to the custom template which will be used to render the HTML report. This option depends on --reporter htmlextra and --reporter-htmlextra-export being present in the run command. If this option is not specified, the default template is used","helpValue":"<path>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-showOnlyFails":{"name":"reporter-htmlextra-showOnlyFails","type":"boolean","description":"Use this optional flag to tell the reporter to display only the requests with failed tests.","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-testPaging":{"name":"reporter-htmlextra-testPaging","type":"boolean","description":"Use this optional flag to add pagination to the tests in the request view.","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-browserTitle":{"name":"reporter-htmlextra-browserTitle","type":"option","description":"Use this optional flag to change the name of the title in the browser tab. The default name is \"Newman Summary Report\".","helpValue":"<title>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-title":{"name":"reporter-htmlextra-title","type":"option","description":"This optional flag can be used to give your report a different main Title in the centre of the report. If this is not set, the report will show \"Newman Run Dashboard\".","helpValue":"<title>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-titleSize":{"name":"reporter-htmlextra-titleSize","type":"option","description":"An optional flag to reduce the size of the main report title. The sizes range from 1 to 6, the higher the number, the smaller the title will be. The default size is 2.","helpValue":"<size>","helpGroup":"HTMLEXTRA reporter","multiple":false,"options":["1","2","3","4","5","6"],"default":"2"},"reporter-htmlextra-logs":{"name":"reporter-htmlextra-logs","type":"boolean","description":"This optional flag shows any console log statements in the collection, on the final report. This is false by default.","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-omitRequestBodies":{"name":"reporter-htmlextra-omitRequestBodies","type":"boolean","description":"An optional flag which allows you to exclude all Request Bodies from the final report","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-omitResponseBodies":{"name":"reporter-htmlextra-omitResponseBodies","type":"boolean","description":"An optional flag which allows you to exclude all Response Bodies from the final report","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-hideRequestBody":{"name":"reporter-htmlextra-hideRequestBody","type":"option","description":"An optional flag which allows you to exclude certain Request Bodies from the final report. Enter the name of the request that you wish to hide.","helpValue":"<request-name>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-hideResponseBody":{"name":"reporter-htmlextra-hideResponseBody","type":"option","description":"An optional flag which allows you to exclude certain Response Bodies from the final report. Enter the name of the request that you wish to hide.","helpValue":"<request-name>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-showEnvironmentData":{"name":"reporter-htmlextra-showEnvironmentData","type":"boolean","description":"An optional flag which allows you to show all the Environment variables used during the run, in the final report","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-skipEnvironmentVars":{"name":"reporter-htmlextra-skipEnvironmentVars","type":"option","description":"An optional flag which allows you to exclude certain Environment variables from the final report","helpValue":"<env-var-name>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-showGlobalData":{"name":"reporter-htmlextra-showGlobalData","type":"boolean","description":"An optional flag which allows you to show all the Global variables used during the run, in the final report","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-skipGlobalVars":{"name":"reporter-htmlextra-skipGlobalVars","type":"option","description":"An optional flag which allows you to exclude certain Global variables from the final report","helpValue":"<global-var-name>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-omitHeaders":{"name":"reporter-htmlextra-omitHeaders","type":"boolean","description":"An optional flag which allows you to exclude all Headers from the final report","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-skipHeaders":{"name":"reporter-htmlextra-skipHeaders","type":"option","description":"An optional flag which allows you to exclude certain Headers from the final report","helpValue":"<header-name>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-skipSensitiveData":{"name":"reporter-htmlextra-skipSensitiveData","type":"boolean","description":"An optional flag that will exclude all the Request/Response Headers and the Request/Response bodies, from each request in the final report. This will only show the main request info and the Test Results. This is false by default.","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-skipFolders":{"name":"reporter-htmlextra-skipFolders","type":"option","description":"An optional flag that will exclude specified folders and their corresponding requests, in the final report. Ensure that folder names are separated with comma ',' and without space.","helpValue":"<req1,req2,...>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-skipRequests":{"name":"reporter-htmlextra-skipRequests","type":"option","description":"An optional flag that will exclude specified requests, in the final report. Ensure that request names are separated with comma ',' and without space.","helpValue":"<req1,req2,...>","helpGroup":"HTMLEXTRA reporter","multiple":false},"reporter-htmlextra-showMarkdownLinks":{"name":"reporter-htmlextra-showMarkdownLinks","type":"boolean","description":"An optional flag which allows you render Markdown links from the test names and pm.expect() statements, in the final report. This could be useful if you use an external bug tracker.","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-noSyntaxHighlighting":{"name":"reporter-htmlextra-noSyntaxHighlighting","type":"boolean","description":"An optional flag which allows you disable the code syntax highlighting. This could enhance the performance of opening larger reports.","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-showFolderDescription":{"name":"reporter-htmlextra-showFolderDescription","type":"boolean","description":"An optional flag which allows you to show all the folder descriptions, in the final report","helpGroup":"HTMLEXTRA reporter","allowNo":false},"reporter-htmlextra-timezone":{"name":"reporter-htmlextra-timezone","type":"option","description":"An optional flag which allows you to set the timezone on the final report's timestamp","helpValue":"<Australia/Sydney\">","helpGroup":"HTMLEXTRA reporter","multiple":false}},"args":[]},"collection:update":{"id":"collection:update","description":"Updates PM collection following changes from your OpenApi V3 (swagger) specification,\nWithout overwrite defined PM events for the existing items (pre-request scripts, test, etc.).","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac collection update --open-api ./path/to/your/open-api-v3-spec.yml\n","$pmac collection update -o ./path/to/your/open-api-v3-spec.yml\n"],"flags":{"open-api":{"name":"open-api","type":"option","char":"o","description":"Path to your OpenApi V3 (known as swagger) specification","required":true,"helpValue":"./path/to/your/openapi.yml","multiple":false}},"args":[]},"config:api-key-delete":{"id":"config:api-key-delete","description":"Update your PM api key","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac pm api-key-update <your-pm-api-key>\n"],"flags":{},"args":[]},"config:api-key-update":{"id":"config:api-key-update","description":"Update your PM api key","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac pm api-key-update <your-pm-api-key>\n"],"flags":{},"args":[{"name":"apiKey","description":"Postman api key","required":true}]},"environment:create":{"id":"environment:create","description":"Creates a new PM environment.","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac environment create \n"],"flags":{"dotEnvPath":{"name":"dotEnvPath","type":"option","char":"e","description":"Specify a relative path to a .env file, to copy values to, [Do not take .env as default!]","required":true,"helpValue":"my/custom/path/to/.env","multiple":false}},"args":[]},"environment:delete":{"id":"environment:delete","description":"Deletes PM environment. default: Deletes from both .pmac (repository), and PM account (remote).","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac environment delete","$pmac environment delete --pm-only","$pmac environment delete --pmac-only"],"flags":{"pm-only":{"name":"pm-only","type":"boolean","char":"r","description":"Removes environment only from your PM account, keeps workspace in .pmac (repository)","required":false,"allowNo":false},"pmac-only":{"name":"pmac-only","type":"boolean","char":"l","description":"Removes environment only from .pmac, keeps workspace in your PM account (remote)","required":false,"allowNo":false}},"args":[]},"environment:pull":{"id":"environment:pull","description":"Pulls (Fetches) new updates about an existing collection on your .pmac (repository).","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac collection pull\n"],"flags":{},"args":[]},"environment:push":{"id":"environment:push","description":"Pushes (Fetches) environment updates to your PM account (remote) from your .pmac (repository).","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac environment push\n"],"flags":{},"args":[]},"environment:update":{"id":"environment:update","description":"Creates a new PM environment.","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac environment create \n"],"flags":{"dotEnvPath":{"name":"dotEnvPath","type":"option","char":"e","description":"Specify a relative path to a .env file, to copy values to, [Do not take .env as default!]","required":true,"helpValue":"my/custom/path/to/.env","multiple":false}},"args":[]},"hello":{"id":"hello","description":"Say hello","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$ oex hello friend --from oclif\nhello friend from oclif! (./src/commands/hello/index.ts)\n"],"flags":{"from":{"name":"from","type":"option","char":"f","description":"Whom is saying hello","required":true,"multiple":false}},"args":[{"name":"person","description":"Person to say hello to","required":true}]},"hello:world":{"id":"hello:world","description":"Say hello world","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$ oex hello world\nhello world! (./src/commands/hello/world.ts)\n"],"flags":{},"args":[]},"init":{"id":"init","description":"Initial pmac environment","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac init --api-key \"your-pm-api-key\"\n","$pmac init -k \"your-pm-api-key\"\n"],"flags":{"api-key":{"name":"api-key","type":"option","char":"k","description":"Postman api key, .pmac need it to integrate with your PM account, if you have not generated one yet, \n please generate it at: https://learning.postman.com/docs/developer/intro-api/","required":true,"multiple":false,"default":""}},"args":[]},"workspace:create":{"id":"workspace:create","description":"Creates new PMAC collection","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac collection create"],"flags":{"api-key":{"name":"api-key","type":"option","char":"k","description":"Dynamic api key","required":false,"helpValue":"<your PM api key>","multiple":false},"name":{"name":"name","type":"option","char":"n","description":"Sets the workspace name without need for stdin question","required":false,"helpValue":"<name>","multiple":false},"type":{"name":"type","type":"option","char":"t","description":"Sets the workspace type without need for stdin question.","required":false,"helpValue":"<type>","multiple":false,"options":["personal","team"]},"skip-description":{"name":"skip-description","type":"boolean","char":"s","description":"Skips questioning for workspace description and set it to an empty string.","required":false,"allowNo":false}},"args":[]},"workspace:delete":{"id":"workspace:delete","description":"Deletes a workspace, allowing deleting a workspace from your Postman account, from pmac (your repo), or both. \n By default deletes both, for more information, use --help.","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["pmac workspace delete","pmac workspace delete -w ./.pmac/workspaces/personal/test-env_pmacf7367da5e7e34110aaeb956db8b7d777/pmac-workspace.json","pmac workspace delete -w ./.pmac/workspaces/personal/test-env_pmacf7367da5e7e34110aaeb956db8b7d777/pmac-workspace.json --pmac-only","pmac workspace delete --pm-only"],"flags":{"pm-only":{"name":"pm-only","type":"boolean","char":"r","description":"Deletes a workspace only from your Postman account, But do not delete the workspace from pmac (your repo).","required":false,"allowNo":false},"pmac-only":{"name":"pmac-only","type":"boolean","char":"l","description":"Deletes only pmac workspace (your repo), But do not delete the workspace from your Postman account.","required":false,"allowNo":false},"workspace-path":{"name":"workspace-path","type":"option","char":"w","required":false,"helpValue":"relative/path/to/your/pmac-workspace.json","multiple":false,"default":""}},"args":[]},"workspace:fetch":{"id":"workspace:fetch","description":"Fetches all pulled workspaces up-to-date.","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["pmac workspace fetch"],"flags":{},"args":[]},"workspace:pull-all":{"id":"workspace:pull-all","description":"Pulls all workspaces within your account.","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac workspace pull-whole-account\n"],"flags":{},"args":[]},"workspace:pull":{"id":"workspace:pull","description":"Pulls a single workspace from PM account","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac workspace pull\n"],"flags":{"id":{"name":"id","type":"option","description":"workspace id","required":false,"helpValue":"<workspace specific id>","multiple":false},"name":{"name":"name","type":"option","char":"n","description":"The exact name of your workspace, on name duplication will pick first match.","required":false,"helpValue":"<workspace name>","multiple":false}},"args":[]},"workspace:push":{"id":"workspace:push","description":"Fetches all pulled workspaces up-to-date.","strict":true,"pluginName":"pmac","pluginAlias":"pmac","pluginType":"core","aliases":[],"examples":["$pmac workspace fetch\n"],"flags":{},"args":[]}}}