haxelib

Search for a Haxe library

$ haxelib search [keyword]

$ haxelib install [libname]

$ haxelib install [libname] [version]

$ haxelib upgrade

$ haxelib git [libname] [git_url]

$ haxelib remove [libname]

$ haxelib list

haxelib command [options] [arguments]

help [command]
    Display usage information, or help for specific command

install lib [version]
    Download and install library from repository

uninstall lib
    Remove an installed library

list [-r|--required]
    List installed libraries, optionally with dependencies

remove lib
    Remove library from repository (alias for uninstall)

search keyword [-r]
    Search libraries by keyword, -r for remote repo

info lib
    Show detailed info on library (version, tags, etc.)

path lib
    Print absolute path to installed library

dev lib [path] [--always] [--global]
    Set library to development version from local path

git lib url [branch]
    Install library from Git repository

hg lib url [branch]
    Install library from Mercurial repository

svn lib url [revision]
    Install library from Subversion repository

run lib [args...]
    Execute main class provided by library

test lib
    Run library tests

newrepo [path]
    Initialize a new local library repository

version
    Print haxelib version

config [var]
    Print or set configuration variables

clone lib url [version] [dest]
    Clone library source from VCS

upgrade [libs...]
    Update listed or all libraries

outdated
    List libraries with newer versions available

repair
    Repair repository integrity

user [name]
    Get or set current Haxe user

set dir value
    Set repository directory

lock project.hxml
    Lock dependencies for project

unlock project.hxml
    Unlock project dependencies

Haxelib is the official command-line package manager for the Haxe programming language, enabling developers to discover, install, update, and manage libraries across Haxe's multi-target compilation ecosystem (web, desktop, mobile, servers). It maintains a local repository of Haxe libraries (.haxelib files), handles dependencies, and supports integration with version control systems like Git, Mercurial, and SVN for development versions.

Users interact via subcommands to search the central repository at lib.haxe.org, install libraries by name or URL, list installed packages with dependency trees, remove or upgrade them, and query paths for compiler use (e.g., -lib flag in haxe). Haxelib also allows running library-provided executables, setting development modes, creating custom repositories, and configuring global settings. It tracks library metadata like versions, authors, and licenses, essential for reproducible builds and project portability.

Installed with the Haxe Toolkit, haxelib simplifies dependency resolution, avoiding manual downloads, and supports project-specific locks for stable CI/CD pipelines. It's lightweight, cross-platform, and crucial for Haxe workflows.

Requires Haxe installation; default repo at https://lib.haxe.org. Custom repos need newrepo. Version conflicts possible without dev or locks. Not for binary deps.

Repo usually at ~/.haxelib or haxelib config to check.

Use -lib libname in haxe to include libraries automatically.

Introduced in Haxe 2.0 (2006) by Nicolas Cannasse. Evolved with Haxe 3+ for VCS support, dependency resolution, and project locks. Central to Haxe 4.x ecosystem, with ongoing updates via Haxe releases.

haxe(1)