slawek/github-release-installer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Enhance README with additional function usage examples and option descriptions

Browse Source
This commit is contained in:
Sławek Koszewski
2026-03-26 14:50:18 +01:00
parent b161511776
commit afdfa13f32
1 changed files with 42 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@@ -32,12 +32,14 @@ Examples:
Useful options: Useful options:
- `--dry-run [level]`: test mode, print what would happen. - `--dry-run [level]`: test mode, print what would happen.
- `--list`: print release asset URLs. - `-l, --list`: print release asset URLs.
- `--file-name <name>`: choose an exact asset name. - `-f, --file-name <name>`: choose an exact asset name.
- `--type <archive|package|zip|tar.gz|tgz|deb|pkg|rpm>`: filter by asset type. - `-t, --type <archive|package|zip|tar.gz|tgz|deb|pkg|rpm>`: filter by asset type.
- `--binary-name <src[:dest]>`: install binary using optional destination name. - `-b, --binary-name <src[:dest]>`: install binary using optional destination name.
- `--output-directory <dir>`: download only, do not install. - `-a, --app-name <name>`: set application display name.
- `--releases-json`: download latest release metadata as JSON. - `-o, --output-directory <dir>`: download only, do not install.
- `-j, --releases-json`: download latest release metadata as JSON.
- `-h, --help`: show usage help.
For full help: For full help:
@@ -45,3 +47,37 @@ For full help:
./github-release-installer --help ./github-release-installer --help
``` ```
### Function usage (when sourced)
If the script is sourced from another installer script, call `github_release_installer` directly.
Use environment variables to set options, for example:
- `ASSET_TYPE='\.tar\.gz$'` to filter for tar.gz assets.
- `ASSET_NAME='gh_2.70.0_macOS_arm64.zip'` to pick an exact file.
- `TEST_MODE=1` to run without downloading/installing.
- `OUTPUT_DIR='/tmp'` to download only.
- `SYSTEM` and `ARCH` to override platform detection.
```bash
source "$(dirname "$0")/github-release-installer"
ASSET_TYPE='\.tar\.gz$'
github_release_installer "Databricks CLI" "databricks" "databricks/cli"
# Pick a specific asset by exact filename
ASSET_NAME='gh_2.70.0_macOS_arm64.zip'
github_release_installer "GitHub CLI" "gh" "cli/cli"
# Dry-run mode (no side effects)
TEST_MODE=1
github_release_installer "GitHub CLI" "gh" "cli/cli"
# Download only (no install)
OUTPUT_DIR='/tmp'
github_release_installer "GitHub CLI" "gh" "cli/cli"
# Override platform detection
SYSTEM='linux'
ARCH='x86_64'
github_release_installer "GitHub CLI" "gh" "cli/cli"
```