mirror of https://github.com/go-sylixos/elvish.git synced 2024-12-01 00:33:05 +08:00

Powerful scripting language & versatile interactive shell add sylixos support.

Go to file

Kurtis Rader fbd86925a9 Prevent I/O deadlocks during shell testing If the shell outputs more data than can be buffered the test will deadlock. I noticed this when working on issue #661. The tests I was writing would deadlock because a tty can buffer significantly less data than a pipe. Even using a pipe, which typically buffers 8 to 128 KiB, this is theoretically a problem. So use a goroutine to capture the output as it is generated rather than reading it all at once when the test terminates.		2020-08-11 15:58:20 +01:00
cmd	website: Restructure directory.	2020-06-14 13:56:58 +01:00
pkg	Prevent I/O deadlocks during shell testing	2020-08-11 15:58:20 +01:00
tools	Deploy to bintray from Cirrus CI, and remove Travis config.	2020-04-03 23:23:23 +01:00
website	Document underscores in number literals	2020-08-01 23:08:11 +01:00
.appveyor.yml	Allow codecov upload to fail.	2020-07-05 19:18:57 +01:00
.cirrus.yml	Allow failures in the gccgo task.	2020-07-21 22:46:28 +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	Format Markdown files.	2020-06-24 23:00:59 +01:00
Dockerfile	Update Dockerfile.	2018-10-22 23:51:09 +01:00
go.mod	Upgrade the xiaq/persistent dependency.	2020-07-14 00:38:21 +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	Create new NEXT-RELEASE.md for 0.15.0.	2020-07-01 22:11:04 +01:00
README.md	README.md: Remove the license badge.	2020-04-04 14:30:08 +01:00

README.md

Elvish: Friendly Interactive Shell and Expressive Programming Language

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):

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

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.