Appcenter-cli: Better Documentation on CLI command switches

Created on 15 Jan 2021  路  4Comments  路  Source: microsoft/appcenter-cli

No where is there a list of switches to use with commands. please add this for somedeity's-sake! I am trying to weed through the google searches to find how to use cli to send to multiple groups and also include release notes. But I would like see what all the -commands and the --commands are I can use when I do something like

appcenter distribute release --debug --app $APP_NAME -r "Not sure if this is release notes as it fails" --group "Tag: our-qa" --file and so on

Its ridiculous that you want us to use this CLI since API is going south but you don't have proper documentation of all the little switch commands. Seriously fed up !!

Distribute question

All 4 comments

Hi @grndvl1!
There's built-in help command, could you point us to what is missing?

appcenter distribute release --help

Upload release binary and trigger distribution, at least one of --store or --group must be specified

Usage: appcenter distribute release -f|--file <arg> [--mandatory] [--silent] [-R|--release-notes-file <arg>]
         [-r|--release-notes <arg>] [-s|--store <arg>] [-g|--group <arg>] [-n|--build-number <arg>]
         [-b|--build-version <arg>] [-a|--app <arg>]

Options:
    -f|--file <arg>                           Path to binary file                                                     
       --mandatory                            Make the release mandatory for the testers (default is false)           
       --silent                               Do not notify testers of this release                                   
    -R|--release-notes-file <arg>             Path to release notes file                                              
    -r|--release-notes <arg>                  Release notes text                                                      
    -s|--store <arg>                          Store name                                                              
    -g|--group <arg>                          Distribution group name                                                 
    -n|--build-number <arg>                   Build number parameter required for macOS .pkg and .dmg files           
    -b|--build-version <arg>                  Build version parameter required for .zip, .msi, .pkg and .dmg files    
    -a|--app <arg>                            Specify app in the <ownerName>/<appName> format                         

Common Options (works on all commands):
       --disable-telemetry             Disable telemetry for this command                                             
    -v|--version                       Display appcenter version                                                      
       --quiet                         Auto-confirm any prompts without waiting for input                             
    -h|--help                          Display help for current command                                               
       --env <arg>                     Environment when using API token                                               
       --token <arg>                   API token                                                                      
       --output <arg>                  Output format: json                                                            
       --debug                         Display extra output for debugging

For arguments release notes and release-notes-file,
I think adding the limitation Limited to 5000 characters or less. is better.

For argument group in master branch,
I think you can add an example for multiple groups usage Join multiple distribution group names with commas ",". Example : "group_name_a,group_name_b".

Hey, @AlanChiou, thanks for giving a hint.
@AlanChiou, @grndvl1 would you have any other suggestions - please have a look at the PR and add your suggestions there.

PR Is now merged. Updated hints are going to be included in the next cli release.
Im closing the thread now, but would you have any other suggestions, feel free to share them in this thread.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mamcx picture mamcx  路  6Comments

danidev-tempus picture danidev-tempus  路  3Comments

malwatte picture malwatte  路  6Comments

carloscuesta picture carloscuesta  路  4Comments

snap608 picture snap608  路  6Comments