.. _cli:

Command Line Interface
=========================================================

.. image:: ../../images/cli.png

.. note::
    On macOS, the command line tools are inside the calibre bundle, for example, if you installed calibre in :file:`/Applications` the command line tools are in :file:`/Applications/calibre.app/Contents/MacOS/`. So, for example, to run :file:`ebook-convert` you would use: :file:`/Applications/calibre.app/Contents/MacOS/ebook-convert`.

Documented commands
--------------------------------------

.. toctree::
    :maxdepth: 1

    calibre
    calibre-customize
    calibre-debug
    calibre-server
    calibre-smtp
    calibredb
    ebook-convert
    ebook-edit
    ebook-meta
    ebook-polish
    ebook-viewer
    fetch-ebook-metadata
    lrf2lrs
    lrfviewer
    lrs2lrf
    web2disk

Undocumented commands
----------------------------------------

  * ebook-device
  * markdown-calibre

You can see usage for undocumented commands by executing them without arguments in a terminal.