configurationengine/doc/cli/common.rst
changeset 3 e7e0ae78773e
parent 0 2e8eeb919028
equal deleted inserted replaced
2:87cfa131b535 3:e7e0ae78773e
       
     1 .. _cone-cli:
       
     2 
     1 Cone command line interface
     3 Cone command line interface
     2 ===========================
     4 ===========================
     3 
     5 
     4 ConE command line interface is desinged to offer different actions. A action can be anything that utilizes the ConE interface and 
     6 ConE command line interface is desinged to offer different actions. A action can be anything that utilizes the ConE interface and 
     5 somehow interacts with a Configuration Project. Each action has it's own set of command line arguments.
     7 somehow interacts with a Configuration Project. Each action has it's own set of command line arguments.
    17 or::
    19 or::
    18 
    20 
    19     cone --help
    21     cone --help
    20   
    22   
    21 And you will get something like this as output::
    23 And you will get something like this as output::
    22 
    24     
    23     Usage: cone_tool.py [action] [options].
    25     Usage: ConE [action] [options].
       
    26     
       
    27     
       
    28     Use ConE [action] -h to get action specific help.
    24     
    29     
    25     Available actions
    30     Available actions
    26         info
    31     Main actions for one or more configurations.
    27         compare
    32         compare : Compare two configurations
    28         merge
    33         fix : Run automatic fixes for configurations.
    29         export
    34         generate : Generate a configuration.
    30         generate
    35         report : Create report of existing report data.
    31         update
    36         update : Update/set values to features in configuration(s).
       
    37         validate : Validate a configuration, or individual confml/imp
    32     
    38     
    33     Use cone_tool.py [action] -h to get action specific help.
       
    34     
    39     
    35     Options:
    40     Actions related to the configuration project maintenance.
    36       --version                         show program's version number and exit
    41         export : Export configurations.
    37       -h, --help                        show this help message and exit 
    42         info : Get information about project / configurations.
    38       -c CONFIG, --configuration=CONFIG  Define the name of the configuration for the action
    43         merge : Merge a configuration/layer to the project.
    39       -v LEVEL, --verbose=LEVEL          Print error, warning and information on system out. 
    44     
    40                                             Possible choices:
    45     
    41                                                 NONE 0
    46     extensions:
    42                                                 CRITICAL 1 
    47         initvariant : Initialize a variant from a cpf.
    43                                                 ERROR 2 
    48         packvariant : Pack (zip) the variant layers of a configuration.
    44                                                 WARNING 3 
    49         rootflatten : Configuration root flattener.
    45                                                 INFO 4 
       
    46                                                 DEBUG 5 
       
    47                                             Default is 3.
       
    48       -p STORAGE, --project=STORAGE      Defines the location of current project. Default is the current working directory.
       
    49 
    50 
    50 
    51 
    51 ConE actions
    52 ConE actions
    52 ------------
    53 ------------
    53 .. toctree::
    54 .. toctree::
    54     :maxdepth: 2
    55     :maxdepth: 1
    55 
    56 
       
    57     generate
       
    58     fix
       
    59     compare
       
    60     report
       
    61     update
       
    62     validate
       
    63     export
       
    64     merge
    56     info
    65     info
    57     compare
    66     initvariant
    58     merge
    67     rootflatten
    59     export
       
    60     generate
       
    61     update
       
    62     report
       
    63 
    68