2018-11-05 08:41:16 +08:00
# Elvish: Friendly Interactive Shell and Expressive Programming Language
2013-06-16 16:45:22 +08:00
2020-04-04 07:19:36 +08:00
[](https://cirrus-ci.com/github/elves/elvish/master)
[](https://cirrus-ci.com/github/elves/elvish/master)
[](https://cirrus-ci.com/github/elves/elvish/master)
[](https://ci.appveyor.com/project/xiaq/elvish)
[](https://codecov.io/gh/elves/elvish)
2017-05-22 00:41:56 +08:00
[](https://goreportcard.com/report/github.com/elves/elvish)
2018-10-10 17:45:06 +08:00
[](https://godoc.elv.sh)
2018-01-01 05:53:35 +08:00
[](https://twitter.com/RealElvishShell)
2017-07-07 08:08:41 +08:00
2018-11-05 08:41:16 +08:00
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.
2018-10-10 17:45:06 +08:00
2020-04-03 08:30:21 +08:00
**Visit the official website https://elv.sh for prebuilt binaries, blog posts,
documentation and other resources.**
2018-10-10 17:45:06 +08:00
2020-03-26 09:29:19 +08:00
User groups (all connected with
2019-12-26 23:48:14 +08:00
[matterbridge ](https://github.com/42wim/matterbridge/ )):
2018-10-10 17:45:06 +08:00
[](https://gitter.im/elves/elvish)
[](https://telegram.me/elvish)
[](https://webchat.freenode.net/?channels=elvish)
2020-03-20 19:23:48 +08:00
[](https://matrix.to/#/#elvish:matrix.org)
2018-10-10 00:45:37 +08:00
2018-10-22 03:44:01 +08:00
## Building Elvish
2020-04-03 08:30:21 +08:00
Most users can just use [prebuilt binaries ](https://elv.sh/get/ ) and do not need
to build from source.
2020-03-26 09:29:19 +08:00
2020-01-14 22:49:32 +08:00
To build Elvish from source, you need
2018-10-22 03:44:01 +08:00
2020-01-14 22:49:32 +08:00
- A supported OS: Linux, {Free,Net,Open}BSD, macOS, or Windows.
2018-10-22 03:44:01 +08:00
2020-03-09 07:57:51 +08:00
**NOTE** : Windows support is experimental, and only Windows 10 is supported.
2018-10-22 03:44:01 +08:00
2020-08-14 05:41:57 +08:00
- Go >= 1.14.
2018-10-22 03:44:01 +08:00
2020-01-14 22:49:32 +08:00
To build Elvish from source, follow these steps:
2018-10-22 03:44:01 +08:00
```sh
2020-01-14 22:49:32 +08:00
# 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
2018-10-22 03:44:01 +08:00
```
2020-01-14 22:49:32 +08:00
This will install Elvish to `~/go/bin` .
Alternatively, you can also just use `go get` to install Elvish:
2018-10-22 03:44:01 +08:00
```sh
2020-01-14 22:49:32 +08:00
go get -u github.com/elves/elvish
2018-10-22 03:44:01 +08:00
```
2020-01-14 22:49:32 +08:00
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 ](https://github.com/golang/go/wiki/SettingGOPATH ) to set
`GOPATH` , and Elvish will be installed to `$GOPATH/bin` instead.
## Contributing to Elvish
2018-10-22 03:44:01 +08:00
2020-01-14 23:12:12 +08:00
See [CONTRIBUTING.md ](CONTRIBUTING.md ) for more notes for contributors.
