mirror of
https://github.com/go-sylixos/elvish.git
synced 2024-12-01 00:33:05 +08:00
77 lines
3.3 KiB
Markdown
77 lines
3.3 KiB
Markdown
# Elvish: Expressive Programming Language + Versatile Interactive Shell
|
|
|
|
[](https://github.com/elves/elvish/actions?query=workflow%3ACI)
|
|
[](https://cirrus-ci.com/github/elves/elvish/master)
|
|
[](https://cirrus-ci.com/github/elves/elvish/master)
|
|
[](https://app.codecov.io/gh/elves/elvish/branch/master)
|
|
[](https://goreportcard.com/report/src.elv.sh)
|
|
[](https://twitter.com/ElvishShell)
|
|
|
|
Elvish is an expressive programming language and a versatile interactive shell,
|
|
combined into one seamless package. 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 thanks to [Matrix](https://matrix.org)):
|
|
[](https://gitter.im/elves/elvish)
|
|
[](https://telegram.me/elvish)
|
|
[](https://web.libera.chat/#elvish)
|
|
[](https://matrix.to/#/#users:elves.sh)
|
|
|
|
## Building Elvish
|
|
|
|
Most users do not need to build Elvish from source. Prebuilt binaries for the
|
|
latest commit are provided for
|
|
[Linux amd64](https://dl.elv.sh/linux-amd64/elvish-HEAD.tar.gz),
|
|
[macOS amd64](https://dl.elv.sh/darwin-amd64/elvish-HEAD.tar.gz),
|
|
[Windows amd64](https://dl.elv.sh/windows-amd64/elvish-HEAD.zip) and
|
|
[many other platforms](https://elv.sh/get).
|
|
|
|
To build Elvish from source, you need
|
|
|
|
- A supported OS: Linux, {Free,Net,Open}BSD, macOS, or Windows 10.
|
|
|
|
**NOTE**: Windows 10 support is experimental.
|
|
|
|
- Go >= 1.15.
|
|
|
|
To build Elvish from source, follow these steps:
|
|
|
|
```sh
|
|
# 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` (or `$GOPATH/bin` if you have set
|
|
`$GOPATH`). You might want to add the directory to your `PATH`.
|
|
|
|
To install it elsewhere, override `ELVISH_MAKE_BIN` in the `make` command:
|
|
|
|
```sh
|
|
make get ELVISH_MAKE_BIN=./elvish # Install to the repo root
|
|
make get ELVISH_MAKE_BIN=/usr/local/bin/elvish # Install to /usr/local/bin
|
|
```
|
|
|
|
To install with plugin support, override `ELVISH_PLUGINS` in the `make` command:
|
|
|
|
```sh
|
|
make get ELVISH_PLUGINS=1 # Install with plugin support
|
|
```
|
|
|
|
## Packaging Elvish
|
|
|
|
See [PACKAGING.md](PACKAGING.md) for notes for packagers.
|
|
|
|
## Contributing to Elvish
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for notes for contributors.
|