emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/term/eshell
History
Henrik Lissner 1f8bf7accb
merge: rewrite-docs 
I've omitted docs/*.org from this merge, as there is still work left to
do there, but I am pushing the module docs early so folks can benefit
from the new docs sooner.
2022-08-03 03:27:50 +02:00
..
autoload docs(eshell): fix +eshell/here docstring 2022-01-27 03:32:10 +01:00
config.el refactor(eshell,term): move hscroll-margin settings 2022-03-31 14:05:45 +02:00
packages.el bump: :term 2021-12-14 01:21:33 +01:00
README.org fix(docs): set mode in file-local vars 2022-08-03 02:46:33 +02:00

README.org

:term eshell

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

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?