Fish shell like syntax highlighting for Zsh.

screenshot shell syntax-highlighting zsh zsh-syntax-highlighting

Go to file

Daniel Shahaf 5b34c23cfa Merge remote-tracking branch 'phy1729/doc-all' * phy1729/doc-all: Remove broken links docs: Create all.md docs: Move docs into docs/ docs: Remove duplicate 'How to activate it' sections docs: Move highlighter headers down one level		2015-11-24 06:30:45 +00:00
docs	Remove broken links	2015-11-24 00:27:21 -06:00
highlighters	docs: Move docs into docs/	2015-11-24 00:09:21 -06:00
images	Add screenshot.	2015-10-24 10:59:20 +00:00
tests	docs copyedit: Rewrap to 80 columns, part 3.	2015-11-24 06:06:16 +00:00
.gitattributes	versionstamp: Set up '.revision-hash' file.	2015-10-19 07:21:20 +00:00
.gitignore	docs: Create all.md	2015-11-24 00:22:26 -06:00
.revision-hash	versionstamp: Set up '.revision-hash' file.	2015-10-19 07:21:20 +00:00
.version	Post-release version number bump.	2015-10-20 14:35:21 +00:00
changelog.md	docs copyedit: Whitespace.	2015-11-24 06:06:16 +00:00
COPYING.md	Bump copyright years, part 2.	2015-09-24 16:48:27 +00:00
Makefile	docs: Create all.md	2015-11-24 00:22:26 -06:00
README.md	docs copyedit: Rewrap to 80 columns, part 4.	2015-11-24 06:06:16 +00:00
release.md	release.md: Add an IRC task.	2015-10-20 14:41:55 +00:00
zsh-syntax-highlighting.plugin.zsh	Added oh-my-zsh zsh-syntax-highlighting plugin.	2011-01-06 05:47:42 +08:00
zsh-syntax-highlighting.zsh	driver: Tolerate KSH_ARRAYS being set in the calling context.	2015-11-17 00:48:22 +00:00

README.md

zsh-syntax-highlighting

Fish shell-like like syntax highlighting for Zsh.

Requirements: zsh 4.3.17+.

This package provides syntax highlighing for the shell zsh. It enables
highlighing of commands whilst they are typed at a zsh prompt into an
interactive terminal. This helps in reviewing commands before running
them, particularly in catching syntax errors.

How to install

Using packages

Arch Linux: community/zsh-syntax-highlighting / AUR/zsh-syntax-highlighting-git
Gentoo: mv overlay
Mac OS X / Homebrew: brew install zsh-syntax-highlighting

In your ~/.zshrc

Clone this repository:

  git clone git://github.com/zsh-users/zsh-syntax-highlighting.git

If git is not installed, you could download a snapshot of the latest
development tree from:

  https://github.com/zsh-users/zsh-syntax-highlighting/archive/master.tar.gz

Source the script at the end of ~/.zshrc:

  source /path/to/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh

Source ~/.zshrc to take changes into account:
```
  source ~/.zshrc
```

With oh-my-zsh

Oh-my-zsh is a zsh configuration framework. It lives at
http://github.com/robbyrussell/oh-my-zsh.

To install zsh-syntax-highlighting under oh-my-zsh:

Clone this repository in oh-my-zsh's plugins directory:

 git clone git://github.com/zsh-users/zsh-syntax-highlighting.git ~/.oh-my-zsh/custom/plugins/zsh-syntax-highlighting

Activate the plugin in ~/.zshrc:

 plugins=( [plugins...] zsh-syntax-highlighting)

Source ~/.zshrc to take changes into account:
```
 source ~/.zshrc
```

Note that zsh-syntax-highlighting must be the last plugin sourced,
so make it the last element of the $plugins array.

System-wide installation

Either of the above methods is suitable for a single-user installation,
which requires no special privileges. If, however, you desire to install
zsh-syntax-highlighting system-wide, you may do so by running make install
and directing your users to add
source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
in their .zshrcs.

FAQ

Why must `zsh-syntax-highlighting.zsh` be sourced at the end of the `.zshrc` file?

zsh-syntax-highlighting.zsh wraps ZLE widgets. It must be sourced after all
custom widgets have been created (i.e., after all zle -N calls and after
running compinit). Widgets created later will work, but will not update the
syntax highlighting.

How are new releases announced?

There is currently no "push" announcements channel. However, the following
alternatives exist:

GitHub's RSS feed of releases: https://github.com/zsh-users/zsh-syntax-highlighting/releases.atom
An anitya entry: https://release-monitoring.org/project/7552/

How to tweak

Syntax highlighting is done by pluggable highlighter scripts. See the
highlighters directory for documentation and configuration
settings.