Skip to content
Instant, pre-configured VS Code development environments.
Go HTML CSS TypeScript JavaScript Shell Other
Branch: master
Clone or download
Latest commit 61d8d38 Aug 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.sail move GO111MODULE=on to ubuntu-dev-go image Jul 1, 2019
.vscode Add sidebar to site Apr 25, 2019
ci Gzip releases Jun 28, 2019
extension Bump extension minor version Aug 9, 2019
hat-examples add tests and example hat for on_start Jun 28, 2019
images move GO111MODULE=on to ubuntu-dev-go image Jul 1, 2019
internal Merge pull request #219 from cdr/on_open-label Jul 1, 2019
site rename on_open to on_start Jun 20, 2019
workflow Update workflow docs May 22, 2019
.gitignore Add demo May 21, 2019
CONTRIBUTING.md Abandon remote hosts for now Apr 9, 2019
LICENSE Add badges and license May 21, 2019
Makefile Add newline to end of Makefile Aug 6, 2019
README.md Add AUR badge and mention in install block May 24, 2019
autocomplete.go Gzip releases Jun 28, 2019
chrome.go Gzip releases Jun 28, 2019
codeserver.go Gzip releases Jun 28, 2019
config.go Gzip releases Jun 28, 2019
config_test.go Doc scaffolding Apr 23, 2019
editcmd.go Gzip releases Jun 28, 2019
globalflags.go Allow repos as filepaths in sail run Jul 1, 2019
go.mod Stream sail edit output to code-server frontend Apr 29, 2019
go.sum autocomplete: fix subcommand generation Apr 29, 2019
hat_builder.go Gzip releases Jun 28, 2019
hat_builder_test.go Add validation tests Apr 25, 2019
lscmd.go Gzip releases Jun 28, 2019
main.go Added version flag (#169) May 23, 2019
project.go Gzip releases Jun 28, 2019
project_test.go add default_organization key to config (#218) Jun 20, 2019
proxycmd.go Gzip releases Jun 28, 2019
repo.go Allow repos as filepaths in sail run Jul 1, 2019
repo_test.go add default_organization key to config (#218) Jun 20, 2019
rmcmd.go Add --with-data flag to remove project directory on rm May 23, 2019
runcmd.go Rename rm to rebuild May 23, 2019
runner.go rename on_open to on_start Jun 20, 2019
runner_test.go add tests and example hat for on_start Jun 28, 2019
sail.js Remove let when setting oldonkeydown May 21, 2019
sail.js.go Remove let when setting oldonkeydown May 21, 2019
sail.js_gen.go Support editing sail Dockerfile inside code-server May 2, 2019
sail_helpers_test.go add default_organization key to config (#218) Jun 20, 2019
shellcmd.go Allow modifying default host/schema used in sail run May 7, 2019
versionmd.go rename on_open to on_start Jun 20, 2019
vscode.go path compatibility fixes to improve WSL compat. (#211) Jun 11, 2019
websocket.go Allow https url in run command May 3, 2019

README.md

sail

"Open Issues" MIT license AUR version Discord

sail is a universal workflow for reproducible, project-defined development environments.

Basically, it lets you open a repo in a VS Code window with a Docker-based backend.

With the browser extension, you can open a repo right from GitHub or GitLab, or you can do

sail run cdr/sshcode

to open a project right from the command line.

Browser extension demo:

Demo

Features

  • No more "It works on my machine", everyone working on the same project is working in the same environment.
  • Stop duplicating effort, source-control and collaborate on the environment.
  • Instant set-up, open an IDE for a project straight from GitHub or GitLab.

Documentation

Documentation is available at https://sail.dev/docs.

Or, you can read it in it's markdown form at site/content/docs.

Quick Start

Requirements

Currently Sail supports both Linux and MacOS. Windows support is planned for a future release.

Before using Sail, there are several dependencies that must be installed on the host system:

Install

For simple, secure and fast installation, the following command will install the latest version of sail for your OS and architecture into /usr/local/bin. You will need to have /usr/local/bin in your $PATH in order to use it.

curl https://sail.dev/install.sh | bash

For Arch users, there is an official AUR package.

Verify the Installation

To verify Sail is properly installed, run sail --help on your system. If everything is installed correctly, you should see Sail's help text.

Run

You should now be able to run sail run cdr/sail from your terminal to start an environment designed for working on the Sail repo.

Browser Extension

To open GitHub or GitLab projects in a Sail environment with a single click, see the browser extension install instructions.

Learn More

Additional docs covering concepts and configuration can be found at https://sail.dev/docs.

You can’t perform that action at this time.