History

Henrik Lissner e4b1ed5a6a refactor(eshell): eshell-prompt-regexp This new default makes eshell-prompt-regexp's consumers a little less susceptible to false positives in garbage/process output and a little more resistant to user changes to eshell-prompt-function. It's also closer to its default value (KISS).		2023-11-24 10:29:29 -05:00
..
autoload	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
config.el	refactor(eshell): eshell-prompt-regexp	2023-11-24 10:29:29 -05:00
packages.el	bump: :term eshell	2023-11-23 17:29:37 -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
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
Usage
Configuration
- TERM name
Troubleshooting
Frequently asked questions
Appendix

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

@hlissner

Become a maintainer?

Module flags

This module has no flags.

Packages

doom-package:eshell-did-you-mean
doom-package:eshell-up
doom-package:eshell-z
doom-package:esh-help
doom-package:shrink-path
if doom-module::completion company
- doom-package:fish-completion
- doom-package:bash-completion

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?