Powerful scripting language & versatile interactive shell add sylixos support.
Go to file
2020-08-16 14:05:13 +01:00
cmd website: Restructure directory. 2020-06-14 13:56:58 +01:00
pkg Replace "HOME" literals with a constant 2020-08-16 14:05:13 +01:00
tools Deploy to bintray from Cirrus CI, and remove Travis config. 2020-04-03 23:23:23 +01:00
website Change slice syntax to use .. instead of :. 2020-08-15 22:52:50 +01:00
.appveyor.yml Allow codecov upload to fail. 2020-07-05 19:18:57 +01:00
.cirrus.yml Bump minimal Go requirement to >= 1.14, now that 1.15 has been released. 2020-08-13 22:41:57 +01:00
.dockerignore Update .dockerignore. 2018-10-16 10:19:20 +01:00
.gitattributes Use .gitattributes to filter go sources through goimports 2014-02-10 12:41:16 +08:00
.gitignore Rewrite pkg/cli/histutil. 2020-07-13 23:46:43 +01:00
CONTRIBUTING.md Document style guide for the doc comment of unexported types and functions. 2020-08-16 14:00:04 +01:00
Dockerfile Update Dockerfile. 2018-10-22 23:51:09 +01:00
go.mod Bump minimal Go requirement to >= 1.14, now that 1.15 has been released. 2020-08-13 22:41:57 +01:00
go.sum Upgrade the xiaq/persistent dependency. 2020-07-14 00:38:21 +01:00
LICENSE Project rename: das -> elvish 2014-01-29 18:44:07 +08:00
main.go Drop the web subprogram from the main program. 2020-04-25 00:26:40 +01:00
Makefile Fix the handling of go test -race 2020-08-01 23:05:59 +01:00
NEXT-RELEASE.md Change slice syntax to use .. instead of :. 2020-08-15 22:52:50 +01:00
README.md Bump minimal Go requirement to >= 1.14, now that 1.15 has been released. 2020-08-13 22:41:57 +01:00

Elvish: Friendly Interactive Shell and Expressive Programming Language

Test Status on Linux Test Status on macOS Test Status on FreeBSD Test status on Windows Test Coverage Go Report Card GoDoc Twitter

Elvish is a friendly interactive shell and an expressive programming language. It runs on Linux, BSDs, macOS and Windows. Despite its pre-1.0 status, it is already suitable for most daily interactive use.

Visit the official website https://elv.sh for prebuilt binaries, blog posts, documentation and other resources.

User groups (all connected with matterbridge): Gitter Telegram Group #elvish on freenode #elvish:matrix.org

Building Elvish

Most users can just use prebuilt binaries and do not need to build from source.

To build Elvish from source, you need

  • A supported OS: Linux, {Free,Net,Open}BSD, macOS, or Windows.

    NOTE: Windows support is experimental, and only Windows 10 is supported.

  • Go >= 1.14.

To build Elvish from source, follow these steps:

# 1. Start from any directory you want to store Elvish's source code
# 2. Clone the Git repository
git clone https://github.com/elves/elvish
# 3. Change into the repository
cd elvish
# 4. Build and install Elvish
make get

This will install Elvish to ~/go/bin.

Alternatively, you can also just use go get to install Elvish:

go get -u github.com/elves/elvish

This will clone the Git repository to ~/go/src/github.com/elves/elvish, updating it if already exists, and install Elvish to ~/go/bin. However, Elvish built this way will lack version information, although it is otherwise fully functional.

Some tips on installation:

  • Remember to add $HOME/go/bin to your PATH so that you can run elvish directly.

  • If you want to install Elvish to a different place, follow these steps to set GOPATH, and Elvish will be installed to $GOPATH/bin instead.

Contributing to Elvish

See CONTRIBUTING.md for more notes for contributors.