cli-stash
Version:
CLI application to manage and work with Atlassian Stash. Work with your Stash project and repositories from Command lines.
1 lines • 274 kB
JSON
{"version":"0.0.6","commands":{"admin:cluster":{"id":"admin:cluster","description":"Gets information about the nodes that currently make up the stash cluster. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#clusteroutput","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:cluster","$ stash admin:cluster --json"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false}},"args":[]},"auth:list":{"id":"auth:list","description":"List al authorized Stash instances.","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash auth:list","$ stash auth:list","$ stash auth:list"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]}},"args":[]},"auth:login":{"id":"auth:login","description":"Login againts Stash instance. Return the Stash Instance data. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#instance","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash auth:login -a \"Alias\" -u \"username\" -p \"password\" -h \"http.//stash.example.com\" --csv","$ stash auth:login -a \"Alias\" -u \"username\" -p \"password\" -h \"http.//stash.example.com\" -o --json"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"username":{"name":"username","type":"option","char":"u","description":"The Stash username to login","required":true,"multiple":false},"password":{"name":"password","type":"option","char":"p","description":"The Stash password","required":true,"multiple":false},"host":{"name":"host","type":"option","char":"h","description":"The Stash host URL to login and work with it","required":true,"multiple":false},"override":{"name":"override","type":"boolean","char":"o","description":"Override the existing Stash instance configuration","required":false,"allowNo":false}},"args":[],"loginRequired":false},"auth:logout":{"id":"auth:logout","description":"Logout againts Stash instance.","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash auth:logout -a \"Alias\" --json","$ stash auth:logout -a \"Alias\""],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false}},"args":[],"loginRequired":false},"groups:list":{"id":"groups:list","description":"Retrieve a page of group names.","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash groups:list -a MyStashAlias --all","$ stash groups:list -a MyStashAlias -l 100 -s 50","$ stash groups:list -a MyStashAlias --filter \"groupName\" --limit 30"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"all":{"name":"all","type":"boolean","description":"Return all records on the same page (instead paginate results)","required":false,"allowNo":false,"exclusive":["limit"]},"limit":{"name":"limit","type":"option","char":"l","description":"Indicates how many results to return per page","required":false,"multiple":false,"exclusive":[],"default":25},"start":{"name":"start","type":"option","char":"s","description":"Indicates which item should be used as the first item in the page of results","required":false,"multiple":false,"exclusive":[],"default":0},"filter":{"name":"filter","type":"option","description":"If specified only group names containing the supplied string will be returned","required":false,"multiple":false}},"args":[]},"markup:preview":{"id":"markup:preview","description":"Preview the generated html for given markdown contents","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash markup:prewiew -a MyStashAlias --data \"#My Markdown Content to preview\"","$ stash markup:prewiew -a MyStashAlias --file \"path/to/markdown/file\"","$ stash markup:prewiew -a MyStashAlias --data \"#My Markdown Content to preview\" --output-file \"path/to/the/output/file.html\" --json"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"Input data. Cannot use with --file, --keyvalue flags. undefined","required":false,"multiple":false,"exclusive":["file","keyvalue"]},"file":{"name":"file","type":"option","char":"f","description":"Input data file path. Cannot use with --data, --keyvalue flags. undefined","required":false,"multiple":false,"exclusive":["data","keyvalue"]},"mode":{"name":"mode","type":"option","description":"The URL Mode.","required":false,"multiple":false},"hardwrap":{"name":"hardwrap","type":"boolean","description":"Hardwrap.","required":false,"allowNo":false},"escape":{"name":"escape","type":"option","description":"Escape HTML.","required":false,"multiple":false},"output-file":{"name":"output-file","type":"option","description":"Output file path. undefined","required":false,"multiple":false}},"args":[]},"projects:create":{"id":"projects:create","description":"Create a new project. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#project","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash projects:create -a MyStashAlias --data \"{ 'key': 'projectkey', 'name':'projectName', 'description'; 'desc', 'avatarFile': 'path/to/avatar' }\" --json","$ stash projects:create -a MyStashAlias --file \"path/to/json/data/file\" --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"JSON Input data. Cannot use with --file, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#projectinput","required":false,"multiple":false,"exclusive":["file","keyvalue"]},"file":{"name":"file","type":"option","char":"f","description":"JSON Input data file path. Cannot use with --data, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#projectinput","required":false,"multiple":false,"exclusive":["data","keyvalue"]}},"args":[]},"projects:delete":{"id":"projects:delete","description":"Delete the project matching the supplied projectKey.","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash projects:delete -a MyStashAlias --key \"ProjectKey\" --csv","$ stash projects:delete -a MyStashAlias --key \"ProjectKey\" --json"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"key":{"name":"key","type":"option","description":"The Project key to delete","required":true,"multiple":false}},"args":[]},"projects:get":{"id":"projects:get","description":"Retrieve the project matching the supplied projectKey. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#project","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash projects:get -a MyStashAlias --key \"ProjectKey\" --csv","$ stash projects:get -a MyStashAlias --key \"ProjectKey\" --json"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"key":{"name":"key","type":"option","description":"The Project key to retrieve","required":true,"multiple":false}},"args":[]},"projects:list":{"id":"projects:list","description":"Retrieve a page of projects. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#project","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash projects:list -a MyStashAlias --all --csv","$ stash projects:list -a MyStashAlias --name \"projectname\" -l 100 -s 50 --json","$ stash projects:list -a MyStashAlias --permission \"ADMIN\" --limit 30"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"all":{"name":"all","type":"boolean","description":"Return all records on the same page (instead paginate results)","required":false,"allowNo":false,"exclusive":["limit"]},"limit":{"name":"limit","type":"option","char":"l","description":"Indicates how many results to return per page","required":false,"multiple":false,"exclusive":[],"default":25},"start":{"name":"start","type":"option","char":"s","description":"Indicates which item should be used as the first item in the page of results","required":false,"multiple":false,"exclusive":[],"default":0},"name":{"name":"name","type":"option","description":"Search projects by name","required":false,"multiple":false},"permission":{"name":"permission","type":"option","description":"Search projects by permission","required":false,"multiple":false}},"args":[]},"projects:update":{"id":"projects:update","description":"Update the project matching the projectKey. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#project","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash projects:update -a MyStashAlias --key \"ProjectKey\" --data \"{ 'key': 'projectkey', 'name':'projectName', 'description'; 'desc', 'avatarFile': 'path/to/avatar' }\" --json","$ stash projects:update -a MyStashAlias --key \"ProjectKey\" --file \"path/to/json/data/file\" --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"JSON Input data. Cannot use with --file, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#projectinput","required":false,"multiple":false,"exclusive":["file","keyvalue"]},"file":{"name":"file","type":"option","char":"f","description":"JSON Input data file path. Cannot use with --data, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#projectinput","required":false,"multiple":false,"exclusive":["data","keyvalue"]},"key":{"name":"key","type":"option","description":"The Project key to update","required":true,"multiple":false}},"args":[]},"repos:list":{"id":"repos:list","description":"Retrieve a page of repositories based on query parameters that control the search. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#repository","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash repos:list -a MyStashAlias --project \"TheProjectName\" --all --csv","$ stash repos:list -a MyStashAlias --project \"TheProjectName\" --permission REPO_READ -l 100 -s 50 --json","$ stash repos:list -a MyStashAlias --visibility public --limit 30"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"all":{"name":"all","type":"boolean","description":"Return all records on the same page (instead paginate results)","required":false,"allowNo":false,"exclusive":["limit"]},"limit":{"name":"limit","type":"option","char":"l","description":"Indicates how many results to return per page","required":false,"multiple":false,"exclusive":[],"default":25},"start":{"name":"start","type":"option","char":"s","description":"Indicates which item should be used as the first item in the page of results","required":false,"multiple":false,"exclusive":[],"default":0},"name":{"name":"name","type":"option","description":" If specified, this will limit the resulting repository list to ones whose name matches this parameter's value. The match will be done case-insensitive and any leading and/or trailing whitespace characters on the name parameter will be stripped.","required":false,"multiple":false},"project":{"name":"project","type":"option","description":"If specified, this will limit the resulting repository list to ones whose project's name matches this parameter's value. The match will be done case-insensitive and any leading and/or trailing whitespace characters on the projectname parameter will be stripped","required":false,"multiple":false},"permission":{"name":"permission","type":"option","description":"If specified, it must be a valid repository permission level name and will limit the resulting repository list to ones that the requesting user has the specified permission level to. If not specified, the default implicit \"read\" permission level will be assumed.","required":false,"multiple":false,"options":["REPO_READ","REPO_WRITE","REPO_ADMIN"]},"visibility":{"name":"visibility","type":"option","description":"If specified, this will limit the resulting repository list based on the repositories visibility","required":false,"multiple":false,"options":["private","public"]}},"args":[]},"tasks:create":{"id":"tasks:create","description":"Create a new task. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#task","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash tasks:create -a MyStashAlias --data \"{ 'text': 'TaskTest', 'anchor':{ 'id': 1, 'type': 'COMMENT' }, 'state': 'OPEN' }\" --json","$ stash tasks:create -a MyStashAlias --file \"path/to/json/data/file\" --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"JSON Input data. Cannot use with --file, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#taskinput","required":false,"multiple":false,"exclusive":["file","keyvalue"]},"file":{"name":"file","type":"option","char":"f","description":"JSON Input data file path. Cannot use with --data, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#taskinput","required":false,"multiple":false,"exclusive":["data","keyvalue"]}},"args":[]},"tasks:delete":{"id":"tasks:delete","description":"Delete a task. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#task","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash tasks:delete -a MyStashAlias --task 1234 --json","$ stash tasks:delete -a MyStashAlias --task 1234 --csv","$ stash tasks:delete -a MyStashAlias --task 1234"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"task":{"name":"task","type":"option","description":"The task id to delete","required":true,"multiple":false}},"args":[]},"tasks:get":{"id":"tasks:get","description":"Update a existing task. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#task","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash tasks:update -a MyStashAlias --task 1234 --json","$ stash tasks:update -a MyStashAlias --task 1234 --csv","$ stash tasks:update -a MyStashAlias --task 1234"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"task":{"name":"task","type":"option","description":"The task id to retrieve","required":true,"multiple":false}},"args":[]},"tasks:update":{"id":"tasks:update","description":"Update a existing task. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#task","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash tasks:update -a MyStashAlias --task 1234 --data \"{ 'text': 'NewTaskTest', 'state': 'RESOLVED' }\" --json","$ stash tasks:update -a MyStashAlias --task 1234 --file \"path/to/json/data/file\" --csv","$ stash tasks:update -a MyStashAlias --task 1234 --data \"{ 'text': 'NewTaskTest' }\" --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"JSON Input data. Cannot use with --file, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#taskinput","required":false,"multiple":false,"exclusive":["file","keyvalue"]},"file":{"name":"file","type":"option","char":"f","description":"JSON Input data file path. Cannot use with --data, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#taskinput","required":false,"multiple":false,"exclusive":["data","keyvalue"]},"task":{"name":"task","type":"option","description":"The task id to update","required":true,"multiple":false}},"args":[]},"users:credentials":{"id":"users:credentials","description":"Update the currently authenticated user's password.","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash users:credentials -a MyStashAlias --data \"{'password':'newPass','passwordConfirm':'newPass','oldPassword':'oldPass'}\" --json","$ stash users:credentials -a MyStashAlias --file \"path/to/json/data/file\""],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"JSON Input data. Cannot use with --file, --keyvalue, --password, --confirm, --old flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#changepasswordinput","required":false,"multiple":false,"exclusive":["file","keyvalue","password","confirm","old"]},"file":{"name":"file","type":"option","char":"f","description":"JSON Input data file path. Cannot use with --data, --keyvalue, --password, --confirm, --old flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#changepasswordinput","required":false,"multiple":false,"exclusive":["data","keyvalue","password","confirm","old"]},"password":{"name":"password","type":"option","description":"The new password","required":false,"multiple":false,"dependsOn":["confirm","old"],"exclusive":["data","file"]},"confirm":{"name":"confirm","type":"option","description":"The new password confirm","required":false,"multiple":false,"dependsOn":["password","old"],"exclusive":["data","file"]},"old":{"name":"old","type":"option","description":"The old password","required":false,"multiple":false,"dependsOn":["password","confirm"],"exclusive":["data","file"]}},"args":[]},"users:get":{"id":"users:get","description":"Retrieve the user matching the supplied userSlug.. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#user","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash users:get -a MyStashAlias --slug \"userslug\" --json","$ stash users:get -a MyStashAlias --slug \"userslug\" --csv","$ stash users:get -a MyStashAlias --slug \"userslug\""],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"slug":{"name":"slug","type":"option","description":"The user slug to retrieve","required":true,"multiple":false}},"args":[]},"users:list":{"id":"users:list","description":"Retrieve a page of users, optionally run through provided filters. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#user","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash users:list -a MyStashAlias --all --csv","$ stash users:list -a MyStashAlias --filter \"userName\" -l 100 -s 50 --json","$ stash users:list -a MyStashAlias --limit 30"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"all":{"name":"all","type":"boolean","description":"Return all records on the same page (instead paginate results)","required":false,"allowNo":false,"exclusive":["limit"]},"limit":{"name":"limit","type":"option","char":"l","description":"Indicates how many results to return per page","required":false,"multiple":false,"exclusive":[],"default":25},"start":{"name":"start","type":"option","char":"s","description":"Indicates which item should be used as the first item in the page of results","required":false,"multiple":false,"exclusive":[],"default":0},"filter":{"name":"filter","type":"option","description":"return only users, whose username, name or email address contain the filter value","required":false,"multiple":false}},"args":[]},"users:update":{"id":"users:update","description":"Update the currently authenticated user's details. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#user","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash users:update -a MyStashAlias --data \"{'name':'jcitizen','displayName':'Jane Citizen','email':'jane@example.com'}\" --json","$ stash users:update -a MyStashAlias --file \"path/to/json/data/file\" --csv","$ stash users:update -a MyStashAlias --data \"{'displayName':'Jane Citizen','email':'jane@example.com'}\" --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"JSON Input data. Cannot use with --file, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#userinput","required":false,"multiple":false,"exclusive":["file","keyvalue"]},"file":{"name":"file","type":"option","char":"f","description":"JSON Input data file path. Cannot use with --data, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#userinput","required":false,"multiple":false,"exclusive":["data","keyvalue"]}},"args":[]},"admin:groups:create":{"id":"admin:groups:create","description":"Create a new group. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#group","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:groups:create -a MyStashAlias --name MyGroup --json","$ stash admin:groups:create -a MyStashAlias --name AnotherGroup --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"name":{"name":"name","type":"option","description":"Name of the group to create","required":true,"multiple":false}},"args":[]},"admin:groups:delete":{"id":"admin:groups:delete","description":"Deletes the specified group, removing them from the system. This also removes any permissions that may have been granted to the group. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#group","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:groups:delete -a MyStashAlias --name MyGroup --json","$ stash admin:groups:delete -a MyStashAlias --name AnotherGroup --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"name":{"name":"name","type":"option","description":"Name of the group to delete","required":true,"multiple":false}},"args":[]},"admin:groups:list":{"id":"admin:groups:list","description":"Retrieve a page of groups. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#group","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:groups:list -a MyStashAlias --all","$ stash admin:groups:list -a MyStashAlias -l 100 -s 50","$ stash admin:groups:list -a MyStashAlias --filter \"groupName\" --limit 30"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"all":{"name":"all","type":"boolean","description":"Return all records on the same page (instead paginate results)","required":false,"allowNo":false,"exclusive":["limit"]},"limit":{"name":"limit","type":"option","char":"l","description":"Indicates how many results to return per page","required":false,"multiple":false,"exclusive":[],"default":25},"start":{"name":"start","type":"option","char":"s","description":"Indicates which item should be used as the first item in the page of results","required":false,"multiple":false,"exclusive":[],"default":0},"filter":{"name":"filter","type":"option","description":"If specified only group names containing the supplied string will be returned","required":false,"multiple":false}},"args":[]},"admin:license:get":{"id":"admin:license:get","description":"Retrieves details about the current license, as well as the current status of the system with regards to the installed license. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#license","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:license:get -a MyStashAlias --json","$ stash admin:license:get -a MyStashAlias --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false}},"args":[]},"admin:license:update":{"id":"admin:license:update","description":"Decodes the provided encoded license and sets it as the active license. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#license","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:license:update -a MyStashAlias --data \"Encoded license to update\" --json","$ stash admin:license:update -a MyStashAlias --file \"path/to/the/encoded/license/data\" --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"Input data. Cannot use with --file, --keyvalue flags. undefined","required":false,"multiple":false,"exclusive":["file","keyvalue"]},"file":{"name":"file","type":"option","char":"f","description":"Input data file path. Cannot use with --data, --keyvalue flags. undefined","required":false,"multiple":false,"exclusive":["data","keyvalue"]}},"args":[]},"admin:mail:delete":{"id":"admin:mail:delete","description":"Deletes the current mail configuration.","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:mail:delete","$ stash admin:mail:delete --json"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false}},"args":[]},"admin:mail:get":{"id":"admin:mail:get","description":"Retrieves the server email address. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#mailhostconfiguration","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:mail:get","$ stash admin:mail:get --json"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false}},"args":[]},"admin:mail:update":{"id":"admin:mail:update","description":"Updates the mail configuration. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#mailhostconfiguration","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:mail:update --data \"{ 'username': 'user', 'sender-address': 'address@email.com' 'hostname': 'host', 'port': 4000, protocol: 'SMTP', 'use-start-tls': true, 'require-start-tls': true }\"","$ stash admin:mail:update --file \"path/to/json/data/file\" --json"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"JSON Input data. Cannot use with --file, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#mailhostconfiguration","required":false,"multiple":false,"exclusive":["file","keyvalue"]},"file":{"name":"file","type":"option","char":"f","description":"JSON Input data file path. Cannot use with --data, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#mailhostconfiguration","required":false,"multiple":false,"exclusive":["data","keyvalue"]}},"args":[]},"admin:users:captcha":{"id":"admin:users:captcha","description":"Clears any CAPTCHA challenge that may constrain the user with the supplied username when they authenticate. Additionally any counter or metric that contributed towards the user being issued the CAPTCHA challenge (for instance too many consecutive failed logins) will also be reset.","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:users:captcha -a MyStashAlias --name \"UserName\" --json"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"name":{"name":"name","type":"option","description":"The name of the user","required":true,"multiple":false}},"args":[]},"admin:users:create":{"id":"admin:users:create","description":"Creates a new user. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#user","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:users:create -a MyStashAlias --data \"{ 'name':'UserName', 'password':'pass', 'displayName':'Name', 'emailAddress':'user@email.com', 'addToDefaultGroup':false, 'notify':false }\" --json","$ stash admin:users:create -a MyStashAlias --file \"path/to/json/data/file\""],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"data":{"name":"data","type":"option","char":"d","description":"JSON Input data. Cannot use with --file, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#createuserinput","required":false,"multiple":false,"exclusive":["file","keyvalue"]},"file":{"name":"file","type":"option","char":"f","description":"JSON Input data file path. Cannot use with --data, --keyvalue flags. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#createuserinput","required":false,"multiple":false,"exclusive":["data","keyvalue"]}},"args":[]},"admin:users:credentials":{"id":"admin:users:credentials","description":"Update a user's password.","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:users:credentials -a MyStashAlias --name \"username\" --password \"password\" --confirm \"password\" --json","$ stash admin:users:credentials -a MyStashAlias --name \"username\" --password \"password\" --confirm \"password\" --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"name":{"name":"name","type":"option","description":"Name of the user","required":true,"multiple":false},"password":{"name":"password","type":"option","description":"The new password to set","required":true,"multiple":false},"confirm":{"name":"confirm","type":"option","description":"The confirm password","required":true,"multiple":false}},"args":[]},"admin:users:delete":{"id":"admin:users:delete","description":"Deletes the specified user, removing them from the system. This also removes any permissions that may have been granted to the user. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#group","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:users:delete -a MyStashAlias --name john.smith --json","$ stash admin:users:delete -a MyStashAlias --name gina.smith --csv"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"csv":{"name":"csv","type":"boolean","description":"Format output as CSV format","required":false,"allowNo":false,"exclusive":["json"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"Show extra columns when format output as table. (Format by default)","allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"The Stash instance alias to identify user and instance to connect with","required":true,"multiple":false},"name":{"name":"name","type":"option","description":"Name of the user to delete","required":true,"multiple":false}},"args":[]},"admin:users:list":{"id":"admin:users:list","description":"Retrieve a page of users. See the JSON Schema on: https://github.com/JJLongoria/stash-cli/blob/main/README.md#user","strict":true,"pluginName":"cli-stash","pluginAlias":"cli-stash","pluginType":"core","aliases":[],"examples":["$ stash admin:users:list -a MyStashAlias --all","$ stash admin:users:list -a MyStashAlias -l 100 -s 50","$ stash admin:users:list -a MyStashAlias --filter \"userName\" --limit 30"],"flags":{"loglevel":{"name":"loglevel","type":"option","description":"The logging level for this command execution","multiple":false,"options":["error","warn","info","debug"]},"json":{"name":"json","