History

Henrik Lissner 88844e9cec docs: simplify internal docs links Fewer links means less confusion. - Merge doom-issue and doom-commit links into doom-ref (for auto-linking Issue/PR/commit references). - Merge doom-module-source and doom-docs-source links into doom-source. - Rename doom-report-issue to doom-report. - Use '!' as the icon for module issues link. - Remove doom-repo (replaced with "doom:*" in :lang org module). - Add doomdir and emacsdir links to :lang org module.		2021-11-21 20:04:28 +01:00
..
autoload	feat(eshell): add vertico completion for eshell history (#5614 )	2021-10-18 01:35:44 +02:00
config.el	tweak(eshell): bind C-l to clear-scrollback	2021-11-21 19:05:18 +01:00
packages.el	bump: :app :checkers :config :emacs :term :tools :ui	2021-09-15 17:47:17 +02:00
README.org	docs: simplify internal docs links	2021-11-21 20:04:28 +01:00

README.org

:term eshell

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
Usage
Configuration
- TERM name
Troubleshooting
Frequently asked questions
Appendix

← Back to module index ! Issues ↖ Github ± Suggest edits ? Help

Description unfold

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

The Emacs Shell or 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

@hlissner

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.
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, 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?