mirrors/doomemacs
1
Fork 0
mirror of https://github.com/doomemacs/doomemacs.git synced 2026-03-07 14:21:47 -08:00
Code Issues Projects Releases Wiki Activity
doomemacs/modules/term/eshell
History
Exact
Henrik Lissner 6c0881c684
nit: revise TODO/FIXME/HACK/REVIEW/etc in comments 
Some were outdated, some were incorrectly labeled, others were already
completed, some were missing... Gotta fix them all.

Also, in :ui hl-todo, there are comments that describe how Doom uses
each of these annotations; those have been updated.
2026-03-02 19:45:09 -05:00
..
autoload nit: revise TODO/FIXME/HACK/REVIEW/etc in comments 2026-03-02 19:45:09 -05:00
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -04:00
config.el nit: revise TODO/FIXME/HACK/REVIEW/etc in comments 2026-03-02 19:45:09 -05:00
packages.el refactor(eshell): swap out {fish,bash}-completion for pcmpl-args 2026-02-22 00:45:39 -05:00
README.org docs(*): replace all-the-icons with nerd-icons 2023-09-16 20:19:11 +02:00

README.org

:term eshell

Description   unfold

This module provides additional features for the built-in Emacs Shell

The Emacs Shell or doom-package:eshell is a shell-like command interpreter implemented in Emacs Lisp. It is an alternative to traditional shells such as bash, zsh, fish, etc. that is built into Emacs and entirely cross-platform.

Maintainers

Become a maintainer?

Module flags

This module has no flags.

Packages

Hacks

  • Even with fish-completion-fallback-on-bash-p non-nil, fish must be installed for bash completion to work. This has been circumvented.
  • doom-package:eshell-did-you-mean does not work on first invocation, so we manually invoke it once.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires either Fish shell or Bash for code completion.

TODO Usage

󱌣 This module's usage documentation is incomplete. Complete it?

  • Command completion with Company
  • fish-style prompt with Git integration
  • z-like directory jumping
  • Command-not-found recommendations

TODO Configuration

󱌣 This module's configuration documentation is incomplete. Complete it?

TERM name

By default, doom-package:eshell sets the $TERM variable to "xterm-256color", which helps with rendering various colours. As eshell is not a terminal emulator, these will not always work 100%. Modifying eshell-term-name to your liking may help.

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?