webi installers

網絡安裝程序

Webi是開發人員安裝工具的方式

• 沒有sudo
• 沒有包裝管理器
• 沒有混亂的系統權限
• 簡而言之：沒有胡說八道

curl https://webi.sh/webi | sh

該存儲庫包含Webinstall.dev的主要和社區縮放軟件包。

Webi的工作原理

• 聯繫人官方版本API下載URL
• 選擇適當的軟件包版本和存檔格式
• 安裝到$HOME/.local/opt或$HOME/.local/bin ，均適當地安裝。
• 通過$HOME/.config/envman/PATH.env更新PATH
• 符號鏈接或複制當前選定版本

從技術上講：

1. <package>/releases.js將軟件包的釋放API轉換為通用格式
   • （即HTML，CSV，TAB或JSON中的特定JSON格式）
   • 常見的釋放API在_common/ （即_common/github.js ）中
2. _webi/bootstrap.sh是一個模板，可為正確的安裝程序提供系統信息
   • 使用OS，CPU和實用程序信息構造用戶代理（即macos ， amd64 ，可以解開tar,zip,xz ）
3. _webi/template.sh是具有常見功能的基本安裝程序模板
   • 檢查版本
   • 下載和解開包裝
   • 更新路徑
   • （重新）鏈接目錄
4. <package>/install.sh可能會為覆蓋_webi/template.sh提供功能
5. 回顧：
   • curl https://webi.sh/<pkg> => bootstrap-<pkg>.sh
   • sh bootstrap-<pkg>.sh => https://webinstall.dev/api/installers/<pkg>@<ver>.sh?formats=zip,tar @<ver>@<ver> sh？
   • sh install-<pkg>.sh =>下載，解開，移動，鏈接，更新路徑

理念（適用於Webi的包裝作者 /維護者）

• 應安裝到$HOME/.local/opt/<package>-<version>或$HOME/.local/bin
• 不需要sudo （除了一次性setcap ，等等）
• 示例：
  • 完整的軟件包：
    • node.js：https：//github.com/webinstall/packages/tree/master/node
    • Golang：https：//github.com/webinstall/packages/tree/master/golang
    • PostgreSQL：https：//github.com/webinstall/packages/tree/master/postgres
  • 單二進制安裝程序：
    • 球童：https：//github.com/webinstall/packages/tree/master/caddy
    • ripgrep：https：//github.com/webinstall/packages/tree/master/ripgrep
    • gitea：https：//github.com/webinstall/packages/tree/master/gitea
  • 便利腳本：
    • Prettier：https：//github.com/webinstall/packages/tree/master/prettier
    • rust-lang：https：//github.com/webinstall/packages/tree/master/rustlang
    • vim-sensible：https：//github.com/webinstall/packages/tree/master/vim-sensible

創建一個安裝程序

一個安裝由4個文件中的5個零件組成：

 my-new-package/
  - README.md (package info in frontmatter)
  - releases.js
  - install.sh (POSIX Shell)
  - install.ps1 (PowerShell)

1. 創建描述
2. 獲取版本
3. 版本檢查（半門）
4. 更新路徑

看到以下示例：

• https://github.com/webinstall/packages/blob/master/rg/
• https://github.com/webinstall/packages/blob/master/golang/

webinstall.dev服務器使用<your-package>/releases.js返回的版本列表來生成具有預先定義的最必要變量和函數的shell腳本。

您只需填寫空白即可。

tl; dr

只需創建一個空目錄並運行測試，直到獲得好結果。

git clone [email protected]:webinstall/webi-installers.git
pushd ./webi-installers/
git submodule update --init
npm clean-install

mkdir -p ./new-package/
node _webi/test.js ./new-package/

1。創建描述

只需從任何現有軟件包中復制格式即可。就是這樣：

README.md ：

 ---
title : Node.js
homepage : https://nodejs.org
tagline : |
  JavaScript V8 runtime
description : |
  Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine
---

``` sh
node -e ' console.log("Hello, World!") '
> Hello, World !
```

1。提取版本

您在此步驟中所做的只是從一種形式的JSON，CSV或TAB或其他形式轉換為webi理解的格式。

• 使用GitHub版本？請參閱ripgrep/releases.js （使用_common/github.js ）
• 有特殊格式嗎？請參閱golang/releases.js或node/releases.js 。

看起來像這樣：

releases.js ：

 module . exports = function ( ) {
  return github ( null , owner , repo ) . then ( function ( all ) {
    // if you need to do something special, you can do it here
    // ...
    return all ;
  } ) ;
} ;

2。 bash安裝程序

1. 您可以設置的變量
2. 您必須定義的功能
3. 便利 /輔助功能

（如果需要的話，可選）您可能定義的bash變量：

 # Define this if the package name is different from the command name (i.e. golang => go)
pkg_cmd_name= " foobar "

# These are used for symlinks, PATH, and test commands
pkg_dst= " $HOME /.local/opt/foobar "
pkg_dst_cmd= " $HOME /.local/opt/foobar/bin/foobar "
# pkg_dst_bin="$(dirname "$pkg_dst_cmd")"

# These are the _real_ locations for the above
pkg_src= " $HOME /.local/opt/foobar-v $WEBI_VERSION "
pkg_src_cmd= " $HOME /.local/opt/foobar-v $WEBI_VERSION /bin/foobar "
# pkg_src_bin="$(dirname "$pkg_src_cmd")"

（必需）一個版本檢查功能，該功能剝奪了所有非變換垃圾

 pkg_get_current_version () {
    # foobar-v1.1.7 => 1.1.7
    echo " $( foobar --version | head -n 1 | sed ' s:foobar-v:: ' ) "
}

對於其餘功能，您可以從示例中復制/粘貼：

 pkg_format_cmd_version () {}         # Override, pretty prints version

pkg_link                            # Override, replaces webi_link()

pkg_pre_install () {                 # Override, runs any webi_* commands
    webi_check                          # for $HOME/.local/opt tools
    webi_download                       # for things that have a releases.js
    webi_extract                        # for .xz, .tar.*, and .zip files
}

pkg_install () {}                    # Override, usually just needs to rename extracted folder to
                                    # "$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION"

pkg_post_install () {                # Override
    webi_path_add " $pkg_dst_bin "        # should probably update PATH
}

pkg_done_message () {}               # Override, pretty print a success message 

腳本API

請參閱webi/template.sh

這些變量將由服務器設置：

WEBI_PKG=example@v1
WEBI_TAG=v1
WEBI_HOST=https://webinstall.dev
WEBI_RELEASES=https://webinstall.dev/api/releases/example@v1 ? os=macos & arch=amd64 & pretty=true
WEBI_CSV=v1.0.2,
WEBI_VERSION=1.0.2
WEBI_MAJOR=1
WEBI_MINOR=0
WEBI_PATCH=2
WEBI_LTS=
WEBI_CHANNEL=stable
WEBI_EXT=tar
WEBI_PKG_URL=https://cdn.example.com/example-macos-amd64.tar.gz
WEBI_PKG_FILE=example-macos-amd64.tar.gz

PKG_NAME=example
PKG_OSES=macos,linux,windows
PKG_ARCHES=amd64,arm64,x86
PKG_FORMATS=zip,xz

WEBI_TMP= ${WEBI_TMP :- " $( mktemp -d -t webinstall-foobar.XXXXXXXX ) " }
WEBI_SINGLE= " " 

webi_check              # Checks to see if the selected version is already installed (and re-links if so)
webi_download           # Downloads the selected release to $HOME/Downloads/webi/<package-name>.tar.gz
webi_extract            # Extracts the download to /tmp/<package-name>-<random>/
webi_path_add /new/path # Adds /new/path to PATH for bash, zsh, and fish
webi_pre_install        # Runs webi_check, webi_download, and webi_extract
webi_install            # Moves extracted files from $WEBI_TMP to $pkg_src
webi_link               # replaces any existing symlink with the currently selected version
webi_post_install       # Runs `webi_path_add $pkg_dst_bin`

路線圖

• 包裝釋放API統一和暴露
• 支持更多Windows軟件包
• 支持任意的git URL（即@github.com/node/node ）
  • （也許是GITHUB的ghi node/node ）
• 支持git作為檔案格式