https://github.com/jez/starter-zshrc

You should really consider switching to zsh!
https://github.com/jez/starter-zshrc

config zsh zshrc

Last synced: about 14 hours ago
JSON representation

You should really consider switching to zsh!

• Host: GitHub
• URL: https://github.com/jez/starter-zshrc
• Owner: jez
• Created: 2016-01-03T07:30:02.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-07-13T00:37:11.000Z (over 7 years ago)
• Last Synced: 2024-12-23T15:42:24.722Z (17 days ago)
• Topics: config, zsh, zshrc
• Language: Shell
• Homepage: http://blog.jez.io/2016/01/03/starter-zsh-setup/
• Size: 4.88 KB
• Stars: 6
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Starter zshrc

Zsh has given me so much mileage with respect to efficiency at the command line.

Looking back I'm a little sad I didn't switch to it sooner. One of the reasons

why it took so long was that I didn't know where to start; with this in mind,

I've collected some of the zsh-specific bits of my dotfiles into one place to

help people hit the ground running.

Note that this is an example _starter_ zshrc. What I mean by this is that it's

more of a skeleton zshrc. It's been crafted with the assumption that you're

coming from bash and you already have some bash config that you're weary to

part with. The content here aims to be minimally invasive, and since zsh is

largely compatible with bash, the rest of your config should fit right in.

## Usage

By default, though, it depends on two external plugins (so it's not as minimal

as it could be). These are [oh-my-zsh][1] and [zsh-syntax-highlighting][2].

```console

# install oh-my-zsh first:

$ git clone https://github.com/robbyrussell/oh-my-zsh ~/.oh-my-zsh

# then install zsh-syntax-highlighting as an oh-my-zsh plugin:

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

# and finally download this zshrc (WARNING: overwrites your current one!):

$ curl https://raw.githubusercontent.com/jez/starter-zshrc/master/zshrc.zsh > ~/.zshrc

$ zsh

```

There are other options to install oh-my-zsh and zsh-syntax-highlighting which

you can find by reading [their][1] [READMEs][2]. Depending on the route you end

up taking, you might have to adjust some of the settings in the actual file.

[1]: https://github.com/robbyrussell/oh-my-zsh

[2]: https://github.com/zsh-users/zsh-syntax-highlighting

## Documentation

The file itself is __heavily commented__. It should explain (at least briefly)

what every line attempts to do.

[Check it out][zshrc] for yourself!

[zshrc]: zshrc.zsh

## License

MIT License. See LICENSE.