configurationengine/doc/cli/common.rst
changeset 0 2e8eeb919028
child 3 e7e0ae78773e
equal deleted inserted replaced
-1:000000000000 0:2e8eeb919028
       
     1 Cone command line interface
       
     2 ===========================
       
     3 
       
     4 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.
       
     6 
       
     7 Calling ConE
       
     8 ------------
       
     9 
       
    10 All ConE commands are wrapped up by the cone.cmd, which executes internally cone_tool.py. The cone_tool.py searches for all conesub_*.py 
       
    11 matching files under the same scripts folder under cone installation. So basically adding a new action is just adding a new conesub_*.py file.
       
    12 
       
    13 To get a list of all available cone commands run::
       
    14 
       
    15     cone -h
       
    16     
       
    17 or::
       
    18 
       
    19     cone --help
       
    20   
       
    21 And you will get something like this as output::
       
    22 
       
    23     Usage: cone_tool.py [action] [options].
       
    24     
       
    25     Available actions
       
    26         info
       
    27         compare
       
    28         merge
       
    29         export
       
    30         generate
       
    31         update
       
    32     
       
    33     Use cone_tool.py [action] -h to get action specific help.
       
    34     
       
    35     Options:
       
    36       --version                         show program's version number and exit
       
    37       -h, --help                        show this help message and exit 
       
    38       -c CONFIG, --configuration=CONFIG  Define the name of the configuration for the action
       
    39       -v LEVEL, --verbose=LEVEL          Print error, warning and information on system out. 
       
    40                                             Possible choices:
       
    41                                                 NONE 0
       
    42                                                 CRITICAL 1 
       
    43                                                 ERROR 2 
       
    44                                                 WARNING 3 
       
    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 
       
    51 ConE actions
       
    52 ------------
       
    53 .. toctree::
       
    54     :maxdepth: 2
       
    55 
       
    56     info
       
    57     compare
       
    58     merge
       
    59     export
       
    60     generate
       
    61     update
       
    62     report
       
    63