Skip to content

lineCode/elvish

 
 

Repository files navigation

Elvish: Friendly and Expressive Shell

Build Status on Travis Build status on AppVeyor Code Coverage on coveralls.io Go Report Card GoDoc License Twitter

Elvish is a friendly and expressive shell for Linux, BSDs, macOS and Windows. Despite being pre-1.0 software, it is already suitable for most daily interactive use.

Most of the resources for Elvish can be found on the official website.

To meet fellow elves, you can join any of these channels (all connected thanks to matterbridge):

Gitter Telegram Group #elvish on freenode

Regardless of whether you consider yourself a master Elf, feel free to contribute! CONTRIBUTING.md has some notes for contributors. You can also join any of these channels to meet fellow developers:

Gitter for Developers Telegram Group for Developers #elvish-dev on freenode

Building Elvish

To build Elvish, you need

  • Linux, {Free,Net,Open}BSD, macOS, or Windows (Windows support is experimental).

  • Go >= 1.10.

If you have not done so, first set up your environment by following How To Write Go Code.

There are two ways to build Elvish. You can build it directly with go get:

go get github.com/elves/elvish

However, binaries built in this way lacks some build-time information; for instance, elvish -version will show unknown. To add such information, use make:

cd `go env GOPATH`/src/github.com/elves/elvish
make get

In either cases, the binary is placed in $GOPATH/bin. Consider adding it to your $PATH if you want to run the Elvish binary you just built by just typing elvish.

About

Friendly and expressive shell

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 95.7%
  • HTML 2.0%
  • CSS 1.1%
  • JavaScript 0.5%
  • Shell 0.3%
  • Makefile 0.3%
  • Other 0.1%