暂无描述

Qi Xiao 280834b32b PACKAGING.md: Fix language tags of code fences. 2 年之前
.github 9027d8369d Configure check_website to cancel in-progress runs. 2 年之前
cmd 33a04f8dc1 Revamp flag handling in pkg/prog. 2 年之前
pkg 8519085327 clitest: Make failures in TestBuffer and TestNotesBuffer fatal. 2 年之前
tools cfcef9ec51 pkg/buildinfo: Use Go's buildinfo to derive version of development builds. 2 年之前
website f8f60953ad Properly deprecate float64. 2 年之前
.cirrus.yml 5dc8c02a32 Simplify FreeBSD CI setup. 2 年之前
.codecov.yml a42b29802a Update .codecov.yml with file rename. 2 年之前
.codespellrc 4d62732ebc Fix "indicies" -> indices. 2 年之前
.dockerignore f9302b1456 Update .dockerignore. 5 年之前
.gitattributes 615cbc2d0b Use .gitattributes to filter go sources through goimports 10 年之前
.gitignore 844a1fedb2 Handle AltGr key combinations on Windows 3 年之前
.gitlab-ci.yml 7a806b7ea2 Add "apk add git" to GitLab CI. 2 年之前
.prettierrc 1d36d299b8 Put flags for prettier in .prettierrc. 2 年之前
0.19.0-release-notes.md f8f60953ad Properly deprecate float64. 2 年之前
CONTRIBUTING.md a8c2d165d3 Simplify pkg/edit/complete/node_path.go with generics. 2 年之前
Dockerfile f7cb556d9b Require Go 1.18. 2 年之前
LICENSE c1711bbd0a Project rename: das -> elvish 10 年之前
Makefile cfcef9ec51 pkg/buildinfo: Use Go's buildinfo to derive version of development builds. 2 年之前
PACKAGING.md 280834b32b PACKAGING.md: Fix language tags of code fences. 2 年之前
README.md cfcef9ec51 pkg/buildinfo: Use Go's buildinfo to derive version of development builds. 2 年之前
SECURITY.md 1d62b0d68b Add a security policy doc. 2 年之前
go.mod f7cb556d9b Require Go 1.18. 2 年之前
go.sum 5f1673c6c4 Use go-cmp to report unexpected test results. 2 年之前

README.md

Elvish: Expressive Programming Language + Versatile Interactive Shell

CI status Test Coverage Go Reference Packaging status Twitter

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.

User groups (all connected thanks to Matrix): Gitter Telegram Group

Documentation

Documentation for Elvish lives on the official website https://elv.sh, including:

The source for the documentation is in the website directory.

Building Elvish

Most users do not need to build Elvish from source. Prebuilt binaries for the latest commit are provided for Linux amd64, macOS amd64, macOS arm64, Windows amd64 and many other platforms.

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.18.

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 $GOBIN, which defaults to $GOPATH/bin or ~/go/bin if $GOPATH is not set.

To install it elsewhere, override ELVISH_MAKE_BIN in the make command:

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

Experimental plugin support

Elvish has experimental support for building and importing plugins, modules written in Go.

However, since plugin support relies on dynamic linking, it is not enabled in the official prebuilt binaries. You need to build Elvish from source, and make sure that CGo is enabled:

make get CGO_ENABLED=1

To build a plugin, see this example.

Packaging Elvish

See PACKAGING.md for notes for packagers.

Contributing to Elvish

See CONTRIBUTING.md for notes for contributors.