Aurum CLI Commands
==================

In this document, we will explain what each command
does and how to use them.


.. begin-cli-commands

Commands
--------

After installing **aurum-cli**, you can type::

    yeukhon@fubini:/home/yeukhon/work$ aurum-cli


and you shall see the following on your terminal:


.. code-block:: bash

    Usage:
      aurum-cli.py create account <username> [--server-ip=<server_ip>]
      aurum-cli.py create exercise <username> <ssh_url> [--server-ip=<server_ip>]
      aurum-cli.py package <scorm_dir>
      aurum-cli.py quickmode <scorm_dir> [--new-user=<username>] [--zip]
      aurum-cli.py -h | --help
      aurum-cli.py --version

.. end-cli-commands

----------


Commands Descriptions
---------------------


aurum-cli create account
~~~~~~~~~~~~~~~~~~~~~~~~

This command will create an Aurum account for user.

.. code-block:: bash

    aurum-cli create account <username> [--server-ip=<server_ip>]
    aurum-cli create account yeukhon
    aurum-cli create account yeukhon --server-ip=http://192.168.1.119


``server-ip`` is a special option if you need to use a different
server other than the default production server.

------------


aurum-cli create exercise
~~~~~~~~~~~~~~~~~~~~~~~~~

This command will create an exercise object on Aurum which knows
about the teacher repository ssh url and the user who created
this exercise. It returns an unique exercise id for a LMS.

.. code-block:: bash

    aurum-cli create exercise <username> <ssh_url> [--server-ip=<server_ip>]
    aurum-cli create exercise yeukhon ssh://hg@bitbucket.org/yeukhon/hw1_teacher_repo
    aurum-cli create exercise yeukhon ssh://hg@bitbucket.org/yeukhon/hw1_teacher_repo --server-ip=http://192.168.1.119

The ``<ssh_url>`` must follow the format ``ssh://hg@bitbucket.org/bbuser/reponame``.


.. note:: **bbuser** username is the username of your Bitbucket account.


------------


aurum-cli package
~~~~~~~~~~~~~~~~~

This command will package the scorm for you if you did not create
one through ``quickmode``. 

.. code-block:: bash

    aurum-cli package <scorm_dir>
    aurum-cli package /home/yeukhon/work/basic_scorm 


+-------------------+--------------------------------------------+
| argument          |               purposes                     |   
+===================+============================================+
| path              | This is the path to ``scorm_dir``. Either  |   
|                   | full path or relative path.                |
+-------------------+--------------------------------------------+


---------------


aurum-cli quickmode
~~~~~~~~~~~~~~~~~~~

This command handles all other commands for user. 

To learn how to use this command, check :ref:`run-quickmode-label` tutorial.

.. code-block:: bash

    aurum-cli quickmode <scorm_dir> [--new-user=<username>] [--zip]
    aurum-cli quickmode /home/yeukhon/work/basic_scorm --new-user=johnwong --zip
    aurum-cli quickmode /home/yeukhon/work/basic_scorm --new-user=johnwong
    aurum-cli quickmode /home/yeukhon/work/basic_scorm --zip

+-------------------+--------------------------------------------+
| argument          |               purposes                     |   
+===================+============================================+
| scorm_dir         | Path of the target scorm module.           |
|                   | Relative or full path is acceptable.       |
+-------------------+--------------------------------------------+


+-------------------+--------------------------------------------+
| option            |               purposes                     |   
+===================+============================================+
| --new-user        | If specify, the command will try to create |
|                   | an Aurum account for the user. This calls  |
|                   | **aurum-cli create account <username>**.   |
+-------------------+--------------------------------------------+
| --zip             | If specify, aurum-cli will auto-zip the    |
|                   | Scorm LMS for the user. The name of the zip|
|                   | is the string specify in **scorm.yaml**.   |   
+-------------------+--------------------------------------------+

-----------

.. note::

    Please use quickmode whenever possible.