Skip to content

Commit

Permalink
env var docs
Browse files Browse the repository at this point in the history
  • Loading branch information
willmcgugan committed Oct 4, 2022
1 parent cc01070 commit 07e3793
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/source/console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,11 @@ Rich respects some standard environment variables.

Setting the environment variable ``TERM`` to ``"dumb"`` or ``"unknown"`` will disable color/style and some features that require moving the cursor, such as progress bars.

If the environment variable ``NO_COLOR`` is set, Rich will disable all color in the output.
If the environment variable ``FORCE_COLOR`` is set, then color/styles will be enabled regardless of the value of ``TERM``. This is useful on CI systems which aren't terminals but can display ansi escape sequences none-the-less.

If ``width``/``height`` arguments are not explicitly provided as arguments to ``Console`` then the environment variables ``COLUMNS``/``LINES`` can be used to set the console width/height. ``JUPYTER_COLUMNS``/``JUPYTER_LINES`` behave similarly and are used in Jupyter.
If the environment variable ``NO_COLOR`` is set, Rich will disable all color in the output. This takes precedence over ``FORCE_COLOR``. See `no_color <https://no-color.org/>`_ for details.

.. note::
The ``NO_COLOR`` environment variable removes _color_ only. Styles such as bold / italic etc. are preserved.

If ``width`` / ``height`` arguments are not explicitly provided as arguments to ``Console`` then the environment variables ``COLUMNS``/``LINES`` can be used to set the console width/height. ``JUPYTER_COLUMNS``/``JUPYTER_LINES`` behave similarly and are used in Jupyter.

0 comments on commit 07e3793

Please sign in to comment.