122 lines
4.4 KiB
ReStructuredText
122 lines
4.4 KiB
ReStructuredText
.. _powerline_plain:
|
|
|
|
Powerline Plain Theme
|
|
=====================
|
|
|
|
A colorful theme, where shows a lot information about your shell session.
|
|
|
|
Provided Information
|
|
--------------------
|
|
|
|
|
|
* Current path
|
|
* Current username and hostname
|
|
* Current time
|
|
* Current shell level
|
|
* Current dirstack level (\ ``pushd`` / ``popd``\ )
|
|
* Current history number
|
|
* Current command number
|
|
* An indicator when connected by SSH
|
|
* An indicator when ``sudo`` has the credentials cached (see the ``sudo`` manpage for more info about this)
|
|
* An indicator when the current shell is inside the Vim editor
|
|
* Battery charging status (depends on the battery plugin)
|
|
* SCM Repository status (e.g. Git, SVN)
|
|
* The current Kubernetes environment
|
|
* The current Python environment (Virtualenv, venv, and Conda are supported) in use
|
|
* The current Ruby environment (rvm and rbenv are supported) in use
|
|
* Last command exit code (only shown when the exit code is greater than 0)
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
This theme is pretty configurable, all the configuration is done by setting environment variables.
|
|
|
|
User Information
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
By default, the username and hostname are shown, but you can change this behavior by setting the value of the following variable:
|
|
|
|
.. code-block::
|
|
|
|
POWERLINE_PROMPT_USER_INFO_MODE="sudo"
|
|
|
|
|
|
For now, the only supported value is ``sudo``\ , which hides the username and hostname, and shows an indicator when ``sudo`` has the credentials cached. Other values have no effect at this time.
|
|
|
|
Clock Format
|
|
^^^^^^^^^^^^
|
|
|
|
You can change the format using the following variable:
|
|
|
|
.. code-block::
|
|
|
|
THEME_CLOCK_FORMAT="%H:%M:%S"
|
|
|
|
|
|
The time/date is printed by the ``date`` command, so refer to its man page to change the format.
|
|
|
|
Segment Order
|
|
^^^^^^^^^^^^^
|
|
|
|
The contents of the prompt can be "reordered", all the "segments" (every piece of information) can take any place. The currently available segments are:
|
|
|
|
|
|
* ``aws_profile`` - Show the current value of the ``AWS_PROFILE`` environment variable
|
|
* ``battery`` - Battery information (you'll need to enable the ``battery`` plugin)
|
|
* ``clock`` - Current time in ``HH:MM:SS`` format
|
|
* ``cwd`` - Current working directory including full folder hierarchy (c.f. ``wd``\ )
|
|
* ``hostname`` - Host name of machine
|
|
* ``in_vim`` - Show identifier if running in ``:terminal`` from vim
|
|
* ``k8s_context`` - Show current kubernetes context
|
|
* ``last_status`` - Exit status of last run command
|
|
* ``python_venv`` - Python virtual environment information (\ ``virtualenv``\ , ``venv``
|
|
and ``conda`` supported)
|
|
* ``ruby`` - Current ruby version if using ``rvm``
|
|
* ``node`` - Current node version (only ``nvm`` is supported)
|
|
* ``scm`` - Version control information, ``git``
|
|
* ``terraform`` - Current terraform workspace
|
|
* ``user_info`` - Current user
|
|
* ``wd`` - Working directory, like ``cwd`` but doesn't show the full folder
|
|
hierarchy, only the directory you're currently in.
|
|
* ``shlvl`` - Show the current shell level (based on ``SHLVL`` environment variable), but only if you are not in root shell
|
|
* ``dirstack`` - Show the current dirstack level (based on ``DIRSTACK`` environment variable), but only if the stack is not empty
|
|
* ``history_number`` - Show current history number
|
|
* ``command_number`` - Show current command number
|
|
|
|
A variable can be defined to set the order of the prompt segments:
|
|
|
|
.. code-block::
|
|
|
|
POWERLINE_PROMPT="user_info scm python_venv ruby cwd"
|
|
|
|
|
|
The example values above are the current default values, but if you want to remove anything from the prompt, simply remove the "string" that represents the segment from the variable.
|
|
|
|
Compact Settings
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
You can configure various aspects of the prompt to use less whitespace. Supported variables are:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Variable
|
|
- Description
|
|
* - POWERLINE_COMPACT_BEFORE_SEPARATOR
|
|
- Removes the leading space before each separator
|
|
* - POWERLINE_COMPACT_AFTER_SEPARATOR
|
|
- Removes the trailing space after each separator
|
|
* - POWERLINE_COMPACT_BEFOR_FIRST_SEGMENT
|
|
- Removes the leading space on the first segment
|
|
* - POWERLINE_COMPACT_AFTER_LAST_SEGMENT
|
|
- Removes the trailing space on the last segment
|
|
* - POWERLINE_COMPACT_PROMPT
|
|
- Removes the space after the prompt character
|
|
* - POWERLINE_COMPACT
|
|
- Enable all Compact settings (you can still override individual settings)
|
|
* - POWERLINE_PROMPT_AFTER
|
|
- Adds characters after the prompt
|
|
|
|
|
|
The default value for all settings is ``0`` (disabled). Use ``1`` to enable.
|