Eget

---

English | 简体中文

eget helps locate, download, and extract prebuilt binaries from GitHub, GitLab, Gitea/Forgejo, and SourceForge.

Forked from https://github.com/zyedidia/eget Refactored and enhanced the tool's functionality.

Features

• Multi-source installs: install or download binaries from GitHub, GitLab, Gitea/Forgejo, SourceForge, direct download URLs, and local files.
• Automatic selection and extraction: filter release assets by OS/arch, keyword, or regex, with SHA-256 verification and common archive extraction.
• Managed package workflow: use add, list, update, and uninstall to manage frequently used tools, record install state, and check batch updates.
• Query and search: query GitHub release info, list assets, and search repositories with native GitHub search qualifiers.
• Cache and proxy support: use download cache, API response cache, proxy_url, and ghproxy for restricted networks or repeated installs.
• Config-driven usage: configure global defaults, repo-level options, and packages.<name> managed packages; config and installed store default to ~/.config/eget/.

Install

• Download from Releases https://github.com/inherelab/eget/releases
• Install by go install command (requires a local Go SDK)

go install github.com/inherelab/eget/cmd/eget@latest

Command Style

eget <command> --options... arguments...

Usage Examples

Install Examples

Install from GitHub:

# install
eget install --tag nightly inhere/markview
# Install and override the executable name
eget install --name chlog gookit/gitw
# Install and override the asset name
eget install --asset zip windirstat/windirstat
# Filter assets with regex
eget install --asset "REG:\\.deb$" owner/repo
# Install to a custom directory
eget install --to ~/.local/bin/fzf junegunn/fzf

Install a SourceForge project:

# Install a SourceForge project directly
eget install sourceforge:winmerge --asset x64,PerUser,setup

Install a GitLab/Gitea/Forgejo project:

# Install from GitLab releases
eget install gitlab:fdroid/fdroidserver
eget install gitlab:gitlab.gnome.org/GNOME/gtk
# Install from Gitea/Forgejo-compatible releases
eget install gitea:codeberg.org/forgejo/forgejo --asset linux,amd64

Install and record:

# Install and record the package definition
eget install --add junegunn/fzf
eget install --add --name rg BurntSushi/ripgrep
# Add a SourceForge project as a managed package
eget add sourceforge:winmerge --name winmerge --system windows/amd64 --asset x64,PerUser,setup

Install GUI apps:

# Install a GUI app; portable GUI apps use global.gui_target by default
eget install --gui sipeed/picoclaw
eget add --gui --name picoclaw sipeed/picoclaw

Download Examples

# download
eget download ip7z/7zip
eget download --file go --to ~/go1.17.5 https://go.dev/dl/go1.17.5.linux-amd64.tar.gz
eget download --file README.md,LICENSE --to ./dist owner/repo
eget download --file "*.txt" owner/repo
eget download --file "bin/*" owner/repo
eget download --extract-all --to ./dist windirstat/windirstat

Query Examples

Query repository info:

# query repo info
eget query owner/repo
eget query --action releases --limit 5 owner/repo
eget query --action assets --tag v1.2.3 owner/repo

Search GitHub repositories:

eget search ripgrep
eget search skillc language:go user:inhere
eget search --limit 5 --sort stars --order desc terminal ui
eget search --json picoclaw user:sipeed

Other Examples

# uninstall
eget uninstall fzf
# list installed packages
eget list|ls
# list all managed and installed packages
eget list --all
# list GUI packages
eget list --gui
# update fzf
eget update fzf
eget update --all

Config Examples

# config
eget add --name fzf --to ~/.local/bin junegunn/fzf
eget config init
eget config list|ls
eget config get global.target
eget config set global.target ~/.local/bin

Supported Targets

The target argument accepted by install and download can be:

• name configured in packages
• GitHub repository, for example owner/repo
• GitHub repository URL, for example https://github.com/owner/repo
• GitLab target, for example gitlab:fdroid/fdroidserver or gitlab:gitlab.gnome.org/GNOME/gtk
• Gitea/Forgejo target, for example gitea:codeberg.org/forgejo/forgejo
• SourceForge target, for example sourceforge:winmerge or sourceforge:winmerge/stable
• Direct download URL, for example https://example.com/file.tar.gz
• Local file path, for example file:///path/to/file

Note: GitLab and Gitea/Forgejo support currently covers install, download, and update for release assets. The first version does not provide query/search parity, private repository authentication, or automatic provider detection from arbitrary web URLs.

Available Commands

install (aliases: i, ins)

• Resolve, download, verify, and extract a target, then record installation state.
• --name can be used to override the installed executable name; without --to, it also acts as the rename hint for single-file assets.
• --gui marks the target as a GUI application. Portable GUI apps use global.gui_target by default, while GUI installers such as .msi or setup.exe are launched and do not record a final install directory. Without --gui, installer-like assets prompt before launch; with --add, a confirmed installer is persisted with is_gui = true.
• With --add, a successful install also writes the repo target to [packages.<name>]; use --name to override the package name.

download (alias: dl)

• Reuses the install pipeline without recording installed state.
• Downloads the raw asset by default; archive extraction only happens when --file or --extract-all is set.

add

• Writes a managed package definition to [packages.<name>] in the config file.

uninstall (aliases: uni, remove, rm)

• Removes installed files and clears the installed store entry without deleting [packages.<name>].

list (alias: ls)

• Lists installed packages by default.
• Use --all / -a to list the union of local managed packages and installed-store entries.
• Use --gui to filter the current list view to GUI applications.

query (alias: q)

• Queries GitHub repository release metadata without installing anything or touching local state.
• Defaults to the latest action, and can switch to info, releases, or assets with --action.

search

• Searches GitHub repositories without installing anything or touching local state.
• Uses the first argument as the keyword and passes remaining arguments through as GitHub search qualifiers, for example language:go, user:inhere, or topic:cli.

update (alias: up)

• Updates a single managed package, or all managed packages with --all.

config (alias: cfg)

• Supports init, list / ls, get KEY, and set KEY VALUE.

Main Options

install, download, and add share these installation-related options:

• --tag: Select a release tag; defaults to latest when omitted.
• --system: Override the target OS/arch, for example windows/amd64 or linux/arm64.
• --to: Set the install or download output path; accepts either a directory or a full file path.
• --file: Select file(s) to extract from an archive; supports comma-separated file names or glob patterns such as README.md,LICENSE.
• --asset: Filter release assets by keyword; multiple filters can be separated by commas. Regex is also supported with the REG: prefix, for example REG:\\.deb$, and exclusions can use ^REG:....
• --source: Download the source archive instead of a prebuilt binary release.
• --extract-all, --ea: Extract all files from the archive instead of selecting a single target file.
• --quiet: Reduce normal command output for scripting or batch use.

Cache behavior is configured via config set global.cache_dir ... or the cache_dir field in the config file.

install additionally supports:

• --add: After a successful install, append the repo target to [packages.<name>] managed config.
• --gui: Install as a GUI application; with --add, persist is_gui = true. Installer-like assets selected without --gui prompt before launch and also persist is_gui = true when confirmed with --add.
• --name: Override the managed package name; for single executable assets, it also acts as the default output-name hint.

update options:

• --all: Check managed packages and update only outdated installed packages.
• --check: Check and list outdated installed packages, same as list --outdated.
• --dry-run: Preview the update plan without performing installation changes.
• --interactive: Interactively select which managed packages to update.

query options:

• --action, -a: Query action. Supported values: latest, releases, assets, info.
• --tag, -t: Select the release tag for the assets action; defaults to latest when omitted.
• --limit, -l: Limit the number of rows returned by the releases action. Default: 10.
• --json, -j: Output JSON for scripting or automation.
• --prerelease, -p: Include prerelease entries for latest and releases.

search options:

• --limit, -l: Limit the number of repositories returned. Default: 10.
• --sort: Sort search results. Supported values: stars, updated.
• --order: Sort order. Supported values: desc, asc.
• --json, -j: Output JSON for scripting or automation.

Global options:

• -v, --verbose: Show more execution details such as API requests, response summaries, asset selection, cache hits, and key workflow steps.

Notes:

• install --name can rename a single executable asset, for example installing chlog-windows-amd64.exe as chlog.exe.
• install --add only applies to repo targets and appends the managed package definition after a successful install.
• global.gui_target is used only for portable GUI applications. GUI installers such as .msi or setup.exe are launched and do not record a final install directory.
• download stores the raw downloaded asset by default; extraction only happens when --file or --extract-all is provided.
• Archive extraction currently supports zip, tar.*, and 7z.
• Argument order follows the cflag/capp parser constraint and must be CMD --OPTIONS... ARGUMENTS....

Configuration

The config file is resolved in this order:

1. EGET_CONFIG
2. ~/.config/eget/eget.toml
3. XDG / LocalAppData fallback path
4. Legacy ~/.eget.toml

Supported config sections:

• [global]
• ["owner/repo"]
• [packages.<name>]

Example:

[global]
target = "~/.local/bin"
cache_dir = "~/.cache/eget"
proxy_url = "http://127.0.0.1:7890"
system = "windows/amd64"

[api_cache]
enable = false
cache_time = 300

[ghproxy]
enable = false
host_url = ""
support_api = true
fallbacks = []

["inhere/markview"]
tag = "nightly"

[packages.markview]
repo = "inhere/markview"
target = "~/.local/bin"
tag = "nightly"
asset_filters = ["windows"]

[packages.winmerge]
repo = "sourceforge:winmerge"
source_path = "stable"
system = "windows/amd64"
asset_filters = ["x64", "PerUser", "setup"]

[packages.forgejo]
repo = "gitea:codeberg.org/forgejo/forgejo"
system = "linux/amd64"
asset_filters = ["linux", "amd64"]

Common fields:

• target
• gui_target
• cache_dir
• proxy_url
• api_cache.enable
• api_cache.cache_time
• ghproxy.enable
• ghproxy.host_url
• ghproxy.support_api
• ghproxy.fallbacks
• system
• tag
• source_path
• file
• asset_filters
• download_source
• extract_all
• is_gui
• quiet
• upgrade_only

Default initialization:

eget config init

This writes:

• global.target = "~/.local/bin"
• global.cache_dir = "~/.cache/eget"
• global.proxy_url = ""
• api_cache.enable = false
• api_cache.cache_time = 300
• ghproxy.enable = false
• ghproxy.host_url = ""
• ghproxy.support_api = true

By default, the file is created at ~/.config/eget/eget.toml.

Directory semantics:

• target is the default install directory
• cache_dir is the default download cache directory
• proxy_url is the global proxy for remote requests; both GitHub lookups and remote downloads use it
• source_path narrows SourceForge discovery under a project's files area, for example stable
• api_cache only caches GitHub API GET responses, and the cache file directory is derived as {cache_dir}/api-cache/
• cache_time is measured in seconds; expired cache entries are refreshed from the network
• ghproxy rewrites GitHub asset download URLs; when support_api = true, it also rewrites api.github.com requests
• ghproxy.fallbacks are tried in order when the primary ghproxy host fails
• proxy_url is the HTTP-layer proxy, while ghproxy rewrites request URLs; both can be enabled together
• download uses cache_dir by default when --to is not provided
• install and download will reuse cached remote download contents from cache_dir when available

The installed-state store also defaults to ~/.config/eget/installed.toml.

Build and Test

make build
make test

Project Structure

The current version has been restructured into an explicit subcommand CLI, with the entry point in cmd/eget/main.go and business logic concentrated under internal/.

• cmd/eget: command entry point
• internal/cli: capp command registration and argument binding
• internal/app: install/add/list/update/config use-case orchestration
• internal/install: find, download, verify, and extract execution pipeline
• internal/config: config loading, merging, and persistence
• internal/installed: installed-state storage
• internal/source/github: GitHub asset discovery
• internal/source/forge: GitLab/Gitea/Forgejo asset discovery

For more details, see docs/DOCS.md.

References

• https://github.com/zyedidia/eget
• https://github.com/gmatheu/eget