Powerful scripting language & versatile interactive shell add sylixos support.
Go to file
2017-12-18 13:31:15 +00:00
build Add builder info, and a -buildinfo flag. 2017-12-04 21:29:53 +01:00
daemon Make daemon work on Windows. 2017-12-15 00:52:03 +00:00
edit edit: Factor out filtering stage of completion. 2017-12-18 13:31:15 +00:00
eval Deadcode removal. 2017-12-18 01:46:06 +00:00
getopt Fix go-vet errors. 2017-05-21 23:20:55 +01:00
glob Fix minor issues found by gofmt, go vet, and misspell. 2017-12-14 01:28:07 +00:00
parse parse: More descriptive error message for unexpected rune. 2017-12-04 00:36:21 +00:00
program Fix daemon build on Windows. 2017-12-15 22:12:59 +01:00
store Replace SQLite with BoltDB (#441) 2017-07-19 22:19:42 +02:00
sys Fix sys.IsATTY, and enable Editor on windows (broken for now) 2017-12-14 19:50:41 +00:00
util Deadcode removal. 2017-12-18 01:46:06 +00:00
vendor Update dependencies. 2017-08-30 20:37:33 +02:00
.appveyor.yml Add config for AppVeyor. 2017-12-04 12:17:50 +00:00
.gitattributes Use .gitattributes to filter go sources through goimports 2014-02-10 12:41:16 +08:00
.gitignore Updated .gitignore (#303) 2017-01-12 00:17:28 +00:00
.travis.yml On TravisCU, don't build with go 1.8 on macOS 2017-12-15 02:45:17 +00:00
.vsts.sh Fix .vsts.sh again. 2017-12-07 01:07:20 +00:00
build-and-upload.elv In Travis, build binary for windows-amd64. 2017-12-04 20:16:53 +01:00
CONTRIBUTING.md Spell "gettable" correctly. 2017-10-15 15:19:45 +02:00
Dockerfile update Dockerfile 2016-02-09 16:43:58 +08:00
Gopkg.lock Use persistent hashmap to implement map. 2017-09-01 01:07:20 +02:00
Gopkg.toml Use the "dep" tool to manage dependencies. 2017-06-12 23:06:30 +01:00
LICENSE Project rename: das -> elvish 2014-01-29 18:44:07 +08:00
main.go Fix main, and make sure Travis tests main as well. 2017-12-08 00:39:55 +00:00
Makefile Makefile: Disable goveralls. 2017-12-16 13:47:07 +00:00
README.md Use shields.io for CI badges, with custom label 2017-12-16 16:31:54 +00:00

A friendly and expressive Unix shell

Build Status on Travis Build status on AppVeyor Build Status on VSTS

GoDoc Code Coverage on codecov.io Go Report Card License Twitter

User groups: Gitter Telegram Group #elvish on freenode

Developer groups: Gitter Telegram Group #elvish on freenode

logo

Elvish is a cross-platform shell suitable for both interactive use and scripting. It features a full-fledged, non-POSIX-shell programming language with advanced features like namespacing and anonymous functions, and a powerful, fully programmable user interface that works well out of the box.

... which is not 100% true yet. Elvish is already suitable for most daily interactive use, but it is not yet complete. Contributions are more than welcome!

This README documents the development aspect of Elvish. Other information is to be found on the website.

Building Elvish

To build Elvish, you need

  • A Go toolchain >= 1.8.

  • Linux (with x86 or amd64 CPU) or macOS (with reasonably new hardware).

    It's quite likely that Elvish works on BSDs and other POSIX operating systems, or other CPU architectures; this is not guaranteed due to the lack of good CI support and developers who use such OSes. Pull requests are welcome.

    Windows support is experimental.

The Correct Way

Elvish is a go-gettable package. To build Elvish, first set up your Go workspace according to How To Write Go Code, and then run

go get github.com/elves/elvish

The Lazy Way

Here is something you can copy-paste into your terminal:

export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin
mkdir -p $GOPATH

go get github.com/elves/elvish

for f in ~/.bashrc ~/.zshrc; do
    printf 'export %s=%s\n' GOPATH '$HOME/go' PATH '$PATH:$GOPATH/bin' >> $f
done

The scripts sets up the Go workspace and runs go get for you. It assumes that you have a working Go installation and currently use bash or zsh.

The Homebrew Way

Users of macOS can build Elvish using Homebrew:

brew install --HEAD elvish

Name

In roguelikes, items made by the elves have a reputation of high quality. These are usually called elven items, but I chose "elvish" because it ends with "sh", a long tradition of Unix shells. It also rhymes with fish, one of the shells that influenced the philosophy of Elvish.

The word "Elvish" should be capitalized like a proper noun. However, when referring to the elvish command, use it in lower case with fixed-width font.

Whoever practices the Elvish way by either contributing to it or simply using it is called an Elf. (You might have guessed this from the name of the GitHub organization.) The official adjective for Elvish (as in "Pythonic" for Python, "Rubyesque" for Ruby) is Elven.