Using Haxelib

If the haxelib command is executed without any arguments, it prints an exhaustive list of all available arguments. Access the http://lib.haxe.org website to view all the libraries available.

The following commands are available:

Basic

haxelib install

haxelib install [project-name] [version]
haxelib install actuate         # Install latest version
haxelib install actuate 1.8.2   # Install specific version

Install the given project. You can optionally specify a specific version to be installed. By default, latest released version will be installed.

haxelib install [library-file]
haxelib install actuate.zip     # Install from zip file

Install the project contained in the zip file.

haxelib install [hxml-file]
haxelib install build.hxml      # Install all dependencies listed in hxml file

Install all the dependencies from a hxml file.

haxelib install all             # Install all dependencies in all hxml files

Install all the dependencies from all hxml files in the current directory.

haxelib update

haxelib update [project-name]
haxelib update minject

Update a single library to the latest version.

haxelib update

Update all the installed projects to their latest version. This command prompts a confirmation for each updating project.

haxelib remove

haxelib remove [project-name] [version]
haxelib remove format            # Remove all versions
haxelib remove format 3.1.2      # Remove the specified version

Remove a complete project or only a specified version if specified.

haxelib list

haxelib list [search]
haxelib list                     # List all installed projects
haxelib list ufront              # List all projects with "ufront" in their name

List all the installed projects and their versions. For each project, the version surrounded by brackets is the current one.

haxelib set

haxelib set [project-name] [version]
haxelib set tink_core 1.0.0-rc.8

Change the current version for a given project. The version must be already installed.

Information

haxelib search

haxelib search [word]
haxelib search tween

Get a list of all haxelib projects with the specified word in the name or description.

haxelib info

haxelib info [project-name]
haxelib info openfl

Show information about this project, including the owner, license, description, website, tags, current version, and release notes for all versions.

haxelib user

haxelib user [user-name]
haxelib user jason

Show information on a given Haxelib user and their projects.

haxelib config

haxelib config

Print the Haxelib repository path. This is where each library will be installed to. You can modify the path using haxelib setup.

If you are in a local repository and want to print the global Haxelib repository path do haxelib --global config.

haxelib path

haxelib path [project-name[:version]...]
haxelib path hscript
haxelib path hscript:2.0.0
haxelib path hscript erazor buddy
haxelib path hscript erazor buddy:1.0.0

Prints the path to one or more libraries, as well as any dependencies and compiler definitions required by those libraries.

You can specify a version by appending :version to the library name. If no version is specified the set version is used.

If a development version is set it'll be used even if a version is specified.

This command is used by Haxe compiler to get required paths and flags for libraries.

haxelib version

haxelib version

Prints the version of Haxelib you are using.

You can change the version of haxelib you are using with haxelib --global set haxelib version

haxelib help

haxelib help

Print the list of available arguments.

Development

haxelib submit

haxelib submit [project.zip]
haxelib submit detox.zip
haxelib sumbit

Submits a zip package to Haxelib so other users can install it.

Alternatively you can run haxelib submit without argument to have Haxelib zip and submit the current directory (excluding names starting with a dot).

If the user name is unknown, you'll be first asked to register an account. If more the project has more than one developer, it will ask you which user you wish to submit as. If the user already exists, you will be prompted for your password.

If you want to modify the project url or description, simply modify your haxelib.json (keeping version information unchanged) and submit it again.

haxelib register

haxelib register [username] [email] [fullname] [password] [passwordconfirmation]

Register a new developer account to be used when submitting.

Missing parameters will be asked interactively.

haxelib dev

haxelib dev [project-name] [directory]
haxelib dev starling ../starling/        # Relative path to starling source.
haxelib dev starling /opt/starling/      # Absolute path to starling source.
haxelib dev starling                     # Cancel dev, use installed version.

Set a development directory for the given project. This directory should either contain a haxelib.json or the source *.hx files. This command is useful when developing a library and testing changes on a project.

If the directory is omitted the development version of the library will be deactivated.

haxelib git

haxelib git [project-name] [git-clone-path] [branch]
haxelib git minject https://github.com/massiveinteractive/minject.git         # Use HTTP git path.
haxelib git minject git@github.com:massiveinteractive/minject.git             # Use SSH git path.
haxelib git minject git@github.com:massiveinteractive/minject.git v2          # Checkout branch or tag `v2`.

Use a git repository as library.

This is useful for using a more up-to-date development version, a fork of the original project, or for having a private library that you do not wish to post to Haxelib.

When you use haxelib update any libraries that are installed using GIT will automatically pull the latest version.

haxelib hg

haxelib hg [project-name] [mercurial-clone-path] [branch]

Use a mercurial repository as library.

Usage is identical to haxelib git.

Miscellaneous

haxelib setup

haxelib setup [path]

Set the Haxelib repository path. To print current path use haxelib config.

Missing parameter will be asked interactively.

haxelib newrepo

haxelib newrepo

Create a local repository in the current directory, to remove it use haxelib deleterepo.

Basic commands will only use the libraries stored in the local repository when you are located in this directory.

To access the global repository add the --global flag.

haxelib deleterepo

haxelib deleterepo

Remove a local repository created with haxelib newrepo from the current directory.

This will remove all libraries contained in it.

haxelib convertxml

haxelib convertxml

Convert the file haxelib.xml from the current directory in the Haxelib 2 xml specification into a file named haxelib.json which can be used by the current Haxelib.

haxelib run

haxelib run [project-name[:version]] [parameters]
haxelib run openfl
haxelib run openfl:2.6.0
haxelib run openfl setup
haxelib run openfl create DisplayingABitmap

Libraries with either a run.n helper or a main class defined in haxelib.json, can be executed using haxelib run.

You can specify the version to run by appending :version, if the library has a development version set the version will be ignored.

The library will receive the HAXELIB_RUN environment variable with value "1" and HAXELIB_RUN_NAME with the name of the library as value.

haxelib proxy

haxelib proxy [host port [username password]]

Configure Haxelib to use a HTTP proxy.

Missing parameters will be asked interactively.

Rerun with an empty host to deactivate the current proxy.

Flags

Warning: when using the run command you need to specify the flags before run, otherwise they'll be passed as arguments to the library.

haxelib --flat

haxelib --flat

Used by haxelib git, do not add the --recursive flag when cloning a git repository.

haxelib --always

haxelib --always

Answer all questions with yes, cannot be used at the same time as --never.

haxelib --system

haxelib --system

Use the version of Haxelib installed with Haxe in the system instead of the one currently set.

Useful if your Haxelib update was broken.

haxelib --debug

haxelib --debug

Display debug information during the execution, cannot be used at the same time as --quiet.

haxelib --quiet

haxelib --quiet

Display less messages during the execution, cannot be used at the same time as --debug.

haxelib --never

haxelib --never

Answer all questions with no, cannot be used at the same time as --always.

haxelib --global

haxelib --global

Force the usage of the global repository even if inside a local repository created with haxelib newrepo.

Parameters

Warning: when using the run command you need to specify the parameters before run, otherwise they'll be passed as arguments to the library.

haxelib -cwd

haxelib -cwd [dir]

Act like the Haxelib command was run from another repository. Affect all commands that use the "current directory".

haxelib -no-timeout

haxelib -no-timeout

Remove timeout when connecting to the Haxelib server, downloading or submitting a library.

haxelib -R

haxelib -R [host:port[/dir]]

Allow the usage of a custom Haxelib server instead of lib.haxe.org.