3 > WebInstall is how developers install their tools
6 curl https://webinstall.dev/webi | bash
9 This repository contains the primary and community-submitted packages for
10 [webinstall.dev](https://webinstall.dev).
12 # Installer Guidelines
14 - Should install to `$HOME/.local/opt/<package>-<version>` or `$HOME/.local/bin`
15 - Should not need `sudo` (except perhaps for a one-time `setcap`, etc)
18 - Node.js: <https://github.com/webinstall/packages/tree/master/node>
19 - Golang: <https://github.com/webinstall/packages/tree/master/golang>
20 - PostgreSQL: <https://github.com/webinstall/packages/tree/master/postgres>
21 - Single-Binary Installers:
22 - Caddy: <https://github.com/webinstall/packages/tree/master/caddy>
23 - Ripgrep: <https://github.com/webinstall/packages/tree/master/ripgrep>
24 - Gitea: <https://github.com/webinstall/packages/tree/master/gitea>
25 - Convenience Scripts:
26 - Prettier: <https://github.com/webinstall/packages/tree/master/prettier>
27 - Rust-lang: <https://github.com/webinstall/packages/tree/master/rustlang>
29 <https://github.com/webinstall/packages/tree/master/vim-sensible>
33 - Contacts official release APIs for download URLs
34 - Selects the appropriate package version and archive format
35 - Installs to `$HOME/.local/`
36 - Updates `PATH` via `$HOME/.config/envman/PATH.env`
37 - Symlinks or copies current selected version
41 1. `<package>/releases.js` transforms the package's release API into a common
43 - (i.e. HTML, CSV, TAB, or JSON into a specific JSON format)
44 - common release APIs are in `_common/` (i.e. `_common/github.js`)
45 2. `_webi/bootstrap.sh` is a template that exchanges system information for a
47 - contructs a user agent with os, cpu, and utility info (i.e. `macos`,
48 `amd64`, can unpack `tar,zip,xz`)
49 3. `_webi/template.sh` is the base installer template with common functions for
51 - downloading & unpacking
53 - (re-)linking directories
54 4. `<package>/install.sh` may provide functions to override `_webi/template.sh`
56 - `curl https://webinstall.dev/<pkg>` => `bootstrap-<pkg>.sh`
57 - `bash bootstrap-<pkg>.sh` =>
58 `https://webinstall.dev/api/installers/<pkg>@<ver>.sh?formats=zip,tar`
59 - `bash install-<pkg>.sh` => download, unpack, move, link, update PATH
61 ## Creating an Installer
63 An install consists of 5 parts in 4 files:
75 3. Version Check (semi-optional)
78 See these **examples**:
80 - https://github.com/webinstall/packages/blob/master/rg/
81 - https://github.com/webinstall/packages/blob/master/golang/
83 The `webinstall.dev` server uses the list of releases returned by
84 `<your-package>/releases.js` to generate a bash script with most necessary
85 variables and functions pre-defined.
87 You just fill in the blanks.
91 Just create an empty directory and run the tests until you get a good result.
94 git clone git@github.com:webinstall/packages.git
100 mkdir -p ./new-package/
101 node _webi/test.js ./new-package/
104 ### 1. Create Description
106 Just copy the format from any of the existing packages. It's like this:
112 # homepage: https://nodejs.org
113 # tagline: JavaScript V8 runtime
115 # Node.jsĀ® is a JavaScript runtime built on Chrome's V8 JavaScript engine
118 # node -e 'console.log("Hello, World!")'
125 This is a dumb format. We know. Historical accident (originally these were in
128 It's in the TODOs to replace this with either YAML or Markdown.
130 ### 1. Fetch Releases
132 All you're doing in this step is just translating from one form of JSON or CSV
133 or TAB or whatever, to a format understood by `webi`.
135 - Using Github releases? See `ripgrep/releases.js` (which uses
137 - Have a special format? See `golang/releases.js` or `node/releases.js`.
144 module.exports = function (request) {
145 return github(request, owner, repo).then(function (all) {
146 // if you need to do something special, you can do it here
153 ### 2. Bash Installer
155 1. Variables _you_ can set
156 2. Functions _you_ must define
157 3. Convenience / Helper Functions
159 (optional, if needed) Bash variables that you _may_ define:
162 # Define this if the package name is different from the command name (i.e. golang => go)
163 pkg_cmd_name="foobar"
165 # These are used for symlinks, PATH, and test commands
166 pkg_dst="$HOME/.local/opt/foobar"
167 pkg_dst_bin="$HOME/.local/opt/foobar/bin"
168 pkg_dst_cmd="$HOME/.local/opt/foobar/bin/foobar"
170 # These are the _real_ locations for the above
171 pkg_src="$HOME/.local/opt/foobar-v$WEBI_VERSION"
172 pkg_src_bin="$HOME/.local/opt/foobar-v$WEBI_VERSION/bin"
173 pkg_src_cmd="$HOME/.local/opt/foobar-v$WEBI_VERSION/bin/foobar"
176 (required) A version check function that strips all non-version junk
179 pkg_get_current_version() {
180 # foobar-v1.1.7 => 1.1.7
181 echo "$(foobar --version | head -n 1 | sed 's:foobar-v::')"
185 For the rest of the functions you can like copy/paste from the examples:
188 pkg_format_cmd_version() {} # Override, pretty prints version
190 pkg_link # Override, replaces webi_link()
192 pkg_pre_install() { # Override, runs any webi_* commands
193 webi_check # for $HOME/.local/opt tools
194 webi_download # for things that have a releases.js
195 webi_extract # for .xz, .tar.*, and .zip files
198 pkg_install() {} # Override, usually just needs to rename extracted folder to
199 # "$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION"
201 pkg_post_install() { # Override
202 webi_path_add "$pkg_dst_bin" # should probably update PATH
205 pkg_done_message() {} # Override, pretty print a success message
210 See `webi/template.sh`
212 These variables will be set by the server:
218 WEBI_HOST=https://webinstall.dev
219 WEBI_RELEASES=https://webinstall.dev/api/releases/example@v1?os=macos&arch=amd64&pretty=true
228 WEBI_PKG_URL=https://cdn.example.com/example-macos-amd64.tar.gz
229 WEBI_PKG_FILE=example-macos-amd64.tar.gz
233 WEBI_TMP=${WEBI_TMP:-"$(mktemp -d -t webinstall-foobar.XXXXXXXX)"}
238 webi_check # Checks to see if the selected version is already installed (and re-links if so)
239 webi_download # Downloads the selected release to $HOME/Downloads/<package-name>.tar.gz
240 webi_extract # Extracts the download to /tmp/<package-name>-<random>/
241 webi_path_add /new/path # Adds /new/path to PATH for bash, zsh, and fish
242 webi_pre_install # Runs webi_check, webi_download, and webi_extract
243 webi_install # Moves extracted files from $WEBI_TMP to $pkg_src
244 webi_link # replaces any existing symlink with the currently selected version
245 webi_post_install # Runs `webi_add_path $pkg_dst_bin`
250 - Wrap release APIs to unify and expose
251 - [ ] Support arbitrary git urls (i.e. `@github.com/node/node`)
252 - (maybe `ghi node/node` for github specifically)
253 - [ ] Support git as an archive format