.. _cli-commands-clt-upmod:

``clt upmod``
============================================================

Summary
------------------------------------------------------------

Upload a module to Canvas.

Usage
------------------------------------------------------------

.. code-block:: console

  $ clt upmod <directory>

Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - Flag
     - Usage
   * - ``-v``, ``--verbose``
     - Increase verbosity to print information
   * - ``-t``, ``--test-run``
     - Print API calls generated by CLT without sending requests

Examples
------------------------------------------------------------

.. code-block:: console

   $ clt upmod Week-01
   $ clt -v upmod Week-01
   $ clt -verbose upmod Week-01
   $ clt -vv upmod Week-01
   $ clt --test-run upmod Week-01

Details
------------------------------------------------------------

CLT loads the module settings and course materials in the directory and converts any Markdown-formatted to content to HTML. CLT then sends API requests to Canvas that:

* create a new module with the title specified in the module settings,
* create Canvas objects corresponding to the course materials in the directories, and
* move each of those objects to the new module.