Skip to content

Latest commit

 

History

History
75 lines (58 loc) · 2.56 KB

README.org

File metadata and controls

75 lines (58 loc) · 2.56 KB
Raw

:term eshell

Description

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.

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.

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

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?

Appendix

🔨 This module has no appendix yet. Write one?