README
¶
sail
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:
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:
- Docker
- Git
- Chrome or Chromium - not required, but strongly recommended for best code-server support. If chrome is not installed, the default browser will be used.
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.
Documentation
¶
There is no documentation for this package.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
browserapp
Package browserapp provides compatibility layer for opening URLs in an electron-style browser wrapper.
|
Package browserapp provides compatibility layer for opening URLs in an electron-style browser wrapper. |
|
codeserver
Package codeserver contains facilities for working with code-server.
|
Package codeserver contains facilities for working with code-server. |
|
nohup
Package nohup provides the ability to daemonize or "disown" a process so that when the current Go program exits, the process still runs as usual.
|
Package nohup provides the ability to daemonize or "disown" a process so that when the current Go program exits, the process still runs as usual. |
|
xexec
Package xexec contains extended os/exec utilities.
|
Package xexec contains extended os/exec utilities. |