Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
xonsh 0.22.3 documentation
xonsh 0.22.3 documentation
  • Xonsh Installation General Guide
  • AppImage
  • Docker container
  • Tutorial
  • Tutorial: History
  • Tutorial: Macros
  • Tutorial: Extensions (Xontribs)
  • Tutorial: Xonsh Projects
  • Tutorial: Events
  • Tutorial: Programmable Tab-Completion
  • Tutorial: Write Your Own History Backend
  • Tutorial: Subprocess Strings
  • Tutorial: prompt_toolkit custom keybindings
  • Bash to Xonsh Translation Guide
  • Editor and IDE Support
  • Subprocess Types Table
  • Python Virtual Environments
  • Keyboard Shortcuts
  • Run Control File
  • Updating and customizing xonsh
  • Environment Variables
  • Built-in Aliases
  • Core Events
  • Platform-specific tips and tricks
  • Xonsh API
    • xonsh.parsers.lexer
    • xonsh.parser
    • xonsh.parsers.ast
    • xonsh.execer
    • xonsh.imphooks
    • xonsh.built_ins
    • xonsh.environ
    • xonsh.aliases
    • xonsh.dirstack
    • xonsh.procs
      • xonsh.procs.executables
      • xonsh.procs.jobs
      • xonsh.procs.pipelines
      • xonsh.procs.posix
      • xonsh.procs.proxies
      • xonsh.procs.readers
      • xonsh.procs.specs
    • xonsh.lib.inspectors
    • xonsh.history
      • xonsh.history.base
      • xonsh.history.diff_history
      • xonsh.history.dummy
      • xonsh.history.json
      • xonsh.history.main
      • xonsh.history.sqlite
    • xonsh.completer
    • xonsh.completers
      • xonsh.completers.base
      • xonsh.completers.bash
      • xonsh.completers.bash_completion
      • xonsh.completers.commands
      • xonsh.completers.completer
      • xonsh.completers.dirs
      • xonsh.completers.environment
      • xonsh.completers.imports
      • xonsh.completers.init
      • xonsh.completers.man
      • xonsh.completers.path
      • xonsh.completers.python
      • xonsh.completers.tools
    • xonsh.prompt
      • xonsh.prompt.base
      • xonsh.prompt.cwd
      • xonsh.prompt.env
      • xonsh.prompt.gitstatus
      • xonsh.prompt.job
      • xonsh.prompt.times
      • xonsh.prompt.vc
    • xonsh.shells
      • xonsh.shells.base_shell
      • xonsh.shells.dumb_shell
      • xonsh.shells.ptk_shell
        • xonsh.shells.ptk_shell.completer
        • xonsh.shells.ptk_shell.formatter
        • xonsh.shells.ptk_shell.history
        • xonsh.shells.ptk_shell.key_bindings
        • xonsh.shells.ptk_shell.updator
      • xonsh.shells.readline_shell
    • xonsh.shells.base_shell
    • xonsh.shells.readline_shell
    • xonsh.shells.ptk_shell
      • xonsh.shells.ptk_shell.completer
      • xonsh.shells.ptk_shell.formatter
      • xonsh.shells.ptk_shell.history
      • xonsh.shells.ptk_shell.key_bindings
      • xonsh.shells.ptk_shell.updator
    • xonsh.lib.pretty
    • xonsh.history.diff_history
    • xonsh.xoreutils
      • xonsh.xoreutils.cat
      • xonsh.xoreutils.echo
      • xonsh.xoreutils.pwd
      • xonsh.xoreutils.tee
      • xonsh.xoreutils.tty
      • xonsh.xoreutils.ulimit
      • xonsh.xoreutils.umask
      • xonsh.xoreutils.uname
      • xonsh.xoreutils.uptime
      • xonsh.xoreutils.util
      • xonsh.xoreutils.which
      • xonsh.xoreutils.xcontext
      • xonsh.xoreutils.yes
    • xonsh.events
    • xonsh.lib
      • xonsh.lib.collections
      • xonsh.lib.inspectors
      • xonsh.lib.itertools
      • xonsh.lib.jsonutils
      • xonsh.lib.lazyasd
      • xonsh.lib.lazyimps
      • xonsh.lib.lazyjson
      • xonsh.lib.modules
      • xonsh.lib.openpy
      • xonsh.lib.os
      • xonsh.lib.pretty
      • xonsh.lib.subprocess
    • xonsh.tools
    • xonsh.platform
    • xonsh.lazyjson
    • xonsh.lazyasd
    • xonsh.lib.openpy
    • xonsh.foreign_shells
    • xonsh.commands_cache
    • xonsh.tracer
    • xonsh.main
    • xonsh.color_tools
    • xonsh.pyghooks
    • xonsh.shells.dumb_shell
    • xonsh.wizard
    • xonsh.xonfig
    • xonsh.xontribs
    • xonsh.codecache
    • xonsh.contexts
    • xontrib
      • xontrib.coreutils
  • Developer’s Guide
  • Xonsh Change Log
  • Frequently Asked Questions
  • Wishlist & To-Dos
Back to top
View this page
Edit this page

xonsh.prompt¶

xonsh.prompt.base

Base prompt, provides PROMPT_FIELDS and prompt related functions

xonsh.prompt.cwd

CWD related prompt formatter

xonsh.prompt.env

Prompt formatter for virtualenv and others

xonsh.prompt.gitstatus

Informative git status prompt formatter.

xonsh.prompt.job

Prompt formatter for jobs fields e.g. current_job.

xonsh.prompt.times

date & time related prompt formatter

xonsh.prompt.vc

Prompt formatter for simple version control branches

Next
xonsh.prompt.base
Previous
xonsh.completers.tools
Copyright © 2026, Anthony Scopatz
Made with Sphinx and @pradyunsg's Furo