configurationengine/doc/cli/common.rst
author terytkon
Thu, 11 Mar 2010 17:04:37 +0200
changeset 0 2e8eeb919028
child 3 e7e0ae78773e
permissions -rw-r--r--
Adding EPL version of configurationengine.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
Cone command line interface
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
===========================
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
ConE command line interface is desinged to offer different actions. A action can be anything that utilizes the ConE interface and 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
somehow interacts with a Configuration Project. Each action has it's own set of command line arguments.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
Calling ConE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
------------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    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 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    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.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
To get a list of all available cone commands run::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
    cone -h
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
or::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
    cone --help
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
  
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
And you will get something like this as output::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
    Usage: cone_tool.py [action] [options].
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
    Available actions
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
        info
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    27
        compare
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    28
        merge
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
        export
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
        generate
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    31
        update
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    32
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    33
    Use cone_tool.py [action] -h to get action specific help.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    34
    
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    35
    Options:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    36
      --version                         show program's version number and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    37
      -h, --help                        show this help message and exit 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
      -c CONFIG, --configuration=CONFIG  Define the name of the configuration for the action
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
      -v LEVEL, --verbose=LEVEL          Print error, warning and information on system out. 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    40
                                            Possible choices:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    41
                                                NONE 0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    42
                                                CRITICAL 1 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    43
                                                ERROR 2 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    44
                                                WARNING 3 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    45
                                                INFO 4 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    46
                                                DEBUG 5 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    47
                                            Default is 3.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    48
      -p STORAGE, --project=STORAGE      Defines the location of current project. Default is the current working directory.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    49
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    51
ConE actions
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
------------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
.. toctree::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    54
    :maxdepth: 2
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    55
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    56
    info
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    57
    compare
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    58
    merge
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    59
    export
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    60
    generate
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    61
    update
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    62
    report
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    63