===============
``origen.boot``
===============

.. automodule:: origen.boot

   .. contents::
      :local:

.. currentmodule:: origen.boot


Functions
=========

- :py:func:`GetOutputFile`:
  Return the console object used by readline so that it can be used for printing in color.

- :py:func:`run_cmd`:
  Run an Origen command. This is the main entry method for the CLI, but it can also


.. autofunction:: GetOutputFile

.. autofunction:: run_cmd


Variables
=========

- :py:data:`parse_and_bind`
- :py:data:`get_line_buffer`
- :py:data:`insert_text`
- :py:data:`clear_history`
- :py:data:`read_init_file`
- :py:data:`read_history_file`
- :py:data:`write_history_file`
- :py:data:`get_current_history_length`
- :py:data:`get_history_length`
- :py:data:`get_history_item`
- :py:data:`set_history_length`
- :py:data:`set_startup_hook`
- :py:data:`set_pre_input_hook`
- :py:data:`set_completer`
- :py:data:`get_completer`
- :py:data:`get_begidx`
- :py:data:`get_endidx`
- :py:data:`set_completer_delims`
- :py:data:`get_completer_delims`
- :py:data:`add_history`
- :py:data:`callback_handler_install`
- :py:data:`callback_handler_remove`
- :py:data:`callback_read_char`
- :py:data:`rl`

.. autodata:: parse_and_bind
   :annotation:

.. autodata:: get_line_buffer
   :annotation:

.. autodata:: insert_text
   :annotation:

.. autodata:: clear_history
   :annotation:

.. autodata:: read_init_file
   :annotation:

.. autodata:: read_history_file
   :annotation:

.. autodata:: write_history_file
   :annotation:

.. autodata:: get_current_history_length
   :annotation:

.. autodata:: get_history_length
   :annotation:

.. autodata:: get_history_item
   :annotation:

.. autodata:: set_history_length
   :annotation:

.. autodata:: set_startup_hook
   :annotation:

.. autodata:: set_pre_input_hook
   :annotation:

.. autodata:: set_completer
   :annotation:

.. autodata:: get_completer
   :annotation:

.. autodata:: get_begidx
   :annotation:

.. autodata:: get_endidx
   :annotation:

.. autodata:: set_completer_delims
   :annotation:

.. autodata:: get_completer_delims
   :annotation:

.. autodata:: add_history
   :annotation:

.. autodata:: callback_handler_install
   :annotation:

.. autodata:: callback_handler_remove
   :annotation:

.. autodata:: callback_read_char
   :annotation:

.. autodata:: rl
   :annotation: