Haxelib

https://lib.haxe.org/documentation/
Admin
Haxelib is the package and library manager for the Haxe ecosystem, allowing developers to install,...
Tokens:9,082
Snippets:148
Trust Score:9.8
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### haxelib install [project-name] [version]

Source: https://lib.haxe.org/documentation/using-haxelib

Installs a specific version of the library.

```bash
haxelib install actuate 1.8.2
```

--------------------------------

### haxelib install [library-file]

Source: https://lib.haxe.org/documentation/using-haxelib

Installs the project contained in a zip file, either from a local file or from a URL.

```bash
# from local file
haxelib install actuate.zip
# from url
haxelib install https://github.com/openfl/actuate/archive/refs/tags/1.9.0.zip
```

--------------------------------

### haxelib config

Source: https://lib.haxe.org/documentation/using-haxelib

Prints the Haxelib repository path where libraries are installed. The path can be modified with 'haxelib setup'. To print the global repository path from a local repository, use 'haxelib --global config'.

```bash
haxelib config
```

--------------------------------

### haxelib install all

Source: https://lib.haxe.org/documentation/using-haxelib

Installs all dependencies in all hxml files.

```bash
haxelib install all
```

--------------------------------

### haxelib install [project-name]

Source: https://lib.haxe.org/documentation/using-haxelib

Installs the latest released version of the specified library.

```bash
haxelib install actuate
```

--------------------------------

### haxelib install [hxml-file]

Source: https://lib.haxe.org/documentation/using-haxelib

Installs all dependencies listed in the specified hxml file.

```bash
haxelib install build.hxml
```

--------------------------------

### Example haxelib.json

Source: https://lib.haxe.org/documentation/creating-a-haxelib-package

A minimal example of a haxelib.json file showing required fields like name, url, license, tags, description, version, classPath, releasenote, contributors, and optional dependencies and main.

```json
{
  "name": "useless_lib",
  "url" : "https://github.com/jasononeil/useless/",
  "license": "MIT",
  "tags": ["cross", "useless"],
  "description": "This library is useless in the same way on every platform.",
  "version": "1.0.0",
  "classPath": "src/",
  "releasenote": "Initial release, everything is working correctly.",
  "contributors": ["Juraj","Jason","Nicolas"],
  "dependencies": {
    "tink_macro": "",
    "nme": "3.5.5"
  },
  "main": "tools.Main"
}
```

--------------------------------

### haxelib install

Source: https://lib.haxe.org/documentation/using-haxelib

The haxelib install command installs libraries from the Haxelib repository. It supports installing the latest version, a specific version, all dependencies from hxml files, or a library from a local zip file or URL.

```APIDOC
## haxelib install [project-name]

### Description
Installs the latest released version of the specified library.

### Usage
```
haxelib install actuate
```
```

```APIDOC
## haxelib install [project-name] [version]

### Description
Installs a specific version of the specified library.

### Usage
```
haxelib install actuate 1.8.2
```
```

```APIDOC
## haxelib install all

### Description
Installs all dependencies listed in all hxml files in the current project.

### Usage
```
haxelib install all
```
```

```APIDOC
## haxelib install [hxml-file]

### Description
Installs all dependencies listed in the specified hxml file.

### Usage
```
haxelib install build.hxml
```
```

```APIDOC
## haxelib install [library-file]

### Description
Installs the project contained in the specified zip file, either from a local file or a URL.

### Usage
```
# from local file
haxelib install actuate.zip
# from url
haxelib install https://github.com/openfl/actuate/archive/refs/tags/1.9.0.zip
```
```

--------------------------------

### haxelib setup

Source: https://lib.haxe.org/documentation/using-haxelib

Sets the Haxelib repository path. Missing parameter prompts interactively. Use `haxelib config` to print current path.

```bash
haxelib setup [path]
```

--------------------------------

### haxelib list [search]

Source: https://lib.haxe.org/documentation/using-haxelib

Lists all installed projects with 'ufront' in their name.

```bash
haxelib list ufront
```

--------------------------------

### haxelib set

Source: https://lib.haxe.org/documentation/using-haxelib

Changes the current version for a given project. If the version is not already installed, a prompt will be shown to install it.

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

--------------------------------

### haxelib list

Source: https://lib.haxe.org/documentation/using-haxelib

Lists all installed projects and their versions, sorted alphabetically. The current version is surrounded by brackets.

```bash
haxelib list
```

--------------------------------

### haxelib user

Source: https://lib.haxe.org/documentation/using-haxelib

Shows information about a Haxelib user and their projects. The example queries user 'jason'.

```bash
haxelib user [user-name]
haxelib user jason
```

--------------------------------

### haxelib --flat

Source: https://lib.haxe.org/documentation/using-haxelib

When installing a library via git, do not add `--recursive` flag when cloning its repository.

```bash
haxelib --flat
```

--------------------------------

### Dependencies in haxelib.json

Source: https://lib.haxe.org/documentation/creating-a-haxelib-package

Example of defining dependencies in haxelib.json, showing a library with any version and one with an exact version.

```json
"dependencies": {
  "tink_macros": "",
  "nme": "3.5.5"
}
```

--------------------------------

### haxelib --skip-dependencies

Source: https://lib.haxe.org/documentation/using-haxelib

When installing or updating a library, dependencies are ignored.

```bash
haxelib --skip-dependencies
```

--------------------------------

### haxelib path

Source: https://lib.haxe.org/documentation/using-haxelib

Prints source paths, dependencies, and compiler definitions for one or more libraries. Versions can be specified with ':version'; if omitted, the development version is used if set, otherwise the set version. The example output shows the result for 'openfl hxcpp format'.

```bash
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
```

```bash
haxelib path openfl hxcpp format
--macro openfl._internal.utils.ExtraParams.include()
/usr/local/lib/haxe/lib/openfl/6.5.3/
-D openfl=6.5.3
/usr/local/lib/haxe/lib/hxcpp/git/
-D hxcpp=3.4.0
/usr/local/lib/haxe/lib/format/3,3,0/
-D format=3.3.0
```

--------------------------------

### Submit a package with haxelib submit

Source: https://lib.haxe.org/documentation/using-haxelib

Submits a zip package to Haxelib for installation. Without an argument, it prompts for a zip file; with a directory, Haxelib zips and submits it, excluding dotfiles. You'll be asked to register, choose a submitter, or enter your password as applicable. Modify haxelib.json to update project metadata and resubmit.

```bash
haxelib submit
haxelib submit detox.zip
haxelib submit .
```

--------------------------------

### haxelib info

Source: https://lib.haxe.org/documentation/using-haxelib

Displays information about a Haxelib project, including owner, license, description, website, tags, current version, and release notes for all versions. The example queries 'openfl'.

```bash
haxelib info [project-name]
haxelib info openfl
```

--------------------------------

### haxelib list

Source: https://lib.haxe.org/documentation/using-haxelib

The haxelib list command lists installed libraries and their versions. It can optionally filter by a search term.

```APIDOC
## haxelib list

### Description
Lists all installed projects and their versions, sorted alphabetically. The current version is surrounded by brackets.

### Usage
```
haxelib list
```
```

```APIDOC
## haxelib list [search]

### Description
Lists all installed projects that match the given search term.

### Usage
```
haxelib list ufront
```
```

--------------------------------

### haxelib update

Source: https://lib.haxe.org/documentation/using-haxelib

Updates all installed projects to their latest version. Prompts for confirmation for each project.

```bash
haxelib update
```

--------------------------------

### haxelib --system

Source: https://lib.haxe.org/documentation/using-haxelib

Uses the version of Haxelib installed with Haxe in the system instead of the currently set one. Useful if Haxelib update was broken.

```bash
haxelib --system
```

--------------------------------

### haxelib search

Source: https://lib.haxe.org/documentation/using-haxelib

Searches for Haxelib projects whose name or description contains the specified word. The example searches for 'tween'.

```bash
haxelib search [word]
haxelib search tween
```

--------------------------------

### Use a git repository as a library with haxelib git

Source: https://lib.haxe.org/documentation/using-haxelib

Installs a library directly from a git repository, allowing use of up-to-date dev versions, forks, or private libraries. haxelib update pulls the latest version automatically. The subDir parameter sets up a dev path to a subdirectory inside the cloned repository.

```bash
haxelib git [project-name] [git-clone-path] [branch] [subDir] [tag]
```

--------------------------------

### haxelib libpath

Source: https://lib.haxe.org/documentation/using-haxelib

Prints the root path of one or more libraries, one path per line. Versions can be specified with ':version'; if omitted, the set version is used. If a development version is set, it is used even if a version is specified. The example output shows the result for 'hxcpp format hscript'.

```bash
haxelib libpath [project-name[:version]...]
haxelib libpath hscript
haxelib libpath hscript:2.0.0
haxelib libpath hscript erazor buddy
haxelib libpath hscript erazor buddy:1.0.0
```

```bash
haxelib libpath hxcpp format hscript
/usr/local/lib/haxe/lib/hxcpp/git/
/usr/local/lib/haxe/lib/format/3,3,0/
/usr/local/lib/haxe/lib/hxcpp/2,1,1/
```

--------------------------------

### haxelib update

Source: https://lib.haxe.org/documentation/using-haxelib

The haxelib update command updates installed libraries to their latest versions. It can update a single library or all installed libraries.

```APIDOC
## haxelib update [project-name]

### Description
Updates a single library to the latest version.

### Usage
```
haxelib update minject
```
```

```APIDOC
## haxelib update

### Description
Updates all installed projects to their latest version. Prompts for confirmation for each project.

### Usage
```
haxelib update
```
```

--------------------------------

### haxelib set

Source: https://lib.haxe.org/documentation/using-haxelib

The haxelib set command changes the current version of an installed library.

```APIDOC
## haxelib set [project-name] [version]

### Description
Changes the current version for a given project. If the version is not already installed, a prompt will be shown to install it.

### Usage
```
haxelib set tink_core 1.0.0-rc.8
```
```

--------------------------------

### Using the random library with --library

Source: https://lib.haxe.org/documentation

Example Haxe program that uses the 'random' library to pick a random element from an array. Compiling without the --library argument results in 'Unknown identifier : Random'; use 'haxe --library random --main Main --interp' to run it.

```haxe
class Main {
  static public function main() {
    var elt = Random.fromArray([1, 2, 3]);
    trace(elt);
  }
}
```

--------------------------------

### haxelib remove

Source: https://lib.haxe.org/documentation/using-haxelib

The haxelib remove command removes installed libraries from the local machine. It can remove all versions of a project or a specific version.

```APIDOC
## haxelib remove [project-name]

### Description
Removes all versions of the specified project from the local machine.

### Usage
```
haxelib remove format
```
```

```APIDOC
## haxelib remove [project-name] [version]

### Description
Removes the specified version of the project from the local machine.

### Usage
```
haxelib remove format 3.1.2
```
```

--------------------------------

### haxelib help

Source: https://lib.haxe.org/documentation/using-haxelib

Prints the list of available arguments for Haxelib.

```bash
haxelib help
```

--------------------------------

### haxelib newrepo

Source: https://lib.haxe.org/documentation/using-haxelib

Creates a local repository in the current directory. Use `haxelib deleterepo` to remove it. Basic commands use local repository when in that directory; add `--global` to access global repository.

```bash
haxelib newrepo
```

--------------------------------

### haxelib --global

Source: https://lib.haxe.org/documentation/using-haxelib

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

```bash
haxelib --global
```

--------------------------------

### Register a Haxelib account

Source: https://lib.haxe.org/documentation/using-haxelib

Creates a new Haxelib developer account for submitting packages. Missing parameters are asked interactively.

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

--------------------------------

### Add library with --library flag

Source: https://lib.haxe.org/documentation/haxelibs-in-projects

Adds a Haxelib library to a Haxe project by passing the --library flag (or -L) to the compiler. Replace libraryname with the actual library name.

```bash
haxe --main Main --library libraryname --js bin/main.js
```

--------------------------------

### haxelib version

Source: https://lib.haxe.org/documentation/using-haxelib

Prints the version of Haxelib you are using. The version can be changed with 'haxelib --global set haxelib version'.

```bash
haxelib version
```

--------------------------------

### haxelib --always

Source: https://lib.haxe.org/documentation/using-haxelib

Answers all questions with yes. Cannot be used at the same time as --never.

```bash
haxelib --always
```

--------------------------------

### haxelib proxy

Source: https://lib.haxe.org/documentation/using-haxelib

Configures Haxelib to use an HTTP proxy. Missing parameters prompt interactively. Rerun with empty host to deactivate proxy.

```bash
haxelib proxy [host port [username password]]
```

--------------------------------

### Add library in OpenFL project.xml

Source: https://lib.haxe.org/documentation/haxelibs-in-projects

Adds a Haxe library to an OpenFL project by including a <haxelib /> tag in project.xml.

```xml
<haxelib name="actuate" />
```

--------------------------------

### haxelib update [project-name]

Source: https://lib.haxe.org/documentation/using-haxelib

Updates a single library to the latest version.

```bash
haxelib update minject
```

--------------------------------

### haxelib -cwd parameter usage

Source: https://lib.haxe.org/documentation/using-haxelib

Shows how to use the -cwd parameter to run Haxelib as if from another directory. From Haxelib 4.2.0, --cwd is also recognized, but older versions only support -cwd.

```bash
haxelib -cwd [dir]
haxelib --cwd [dir] # also recognized from Haxelib 4.2.0
```

--------------------------------

### Pre-release version format

Source: https://lib.haxe.org/documentation/creating-a-haxelib-package

Format for pre-release versions (alpha, beta, release candidate) with optional release number.

```text
major.minor.patch-(alpha/beta/rc).release
```

--------------------------------

### haxelib run

Source: https://lib.haxe.org/documentation/using-haxelib

Runs a library with a `run.n` helper, `Run.hx` module, or main class defined in `haxelib.json`. Specify version with `:version`; development version used if set (except before 4.2.0 due to bug). Sets `HAXELIB_RUN` and `HAXELIB_RUN_NAME` environment variables. Working directory is library directory; original cwd is last argument.

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

--------------------------------

### Version format

Source: https://lib.haxe.org/documentation/creating-a-haxelib-package

The basic version format used by haxelib: major.minor.patch.

```text
major.minor.patch
```

--------------------------------

### Use a Mercurial repository as a library with haxelib hg

Source: https://lib.haxe.org/documentation/using-haxelib

Uses a Mercurial repository as a library. Usage is identical to haxelib git.

```bash
haxelib hg [project-name] [mercurial-clone-path] [branch] [subDir] [revision]
```

--------------------------------

### haxelib remove [project-name] [version]

Source: https://lib.haxe.org/documentation/using-haxelib

Removes the specified version of the project from the local machine.

```bash
haxelib remove format 3.1.2
```

--------------------------------

### haxelib --quiet

Source: https://lib.haxe.org/documentation/using-haxelib

Displays less messages during execution. Cannot be used at the same time as --debug.

```bash
haxelib --quiet
```

--------------------------------

### haxelib --debug

Source: https://lib.haxe.org/documentation/using-haxelib

Displays debug information during execution. Cannot be used at the same time as --quiet.

```bash
haxelib --debug
```

--------------------------------

### haxelib -R parameter usage

Source: https://lib.haxe.org/documentation/using-haxelib

Shows how to use the -R parameter to specify a custom Haxelib server. The --remote alias is available from Haxelib 4.2.0.

```bash
haxelib -R [host:port[/dir]]
haxelib --remote [host:port[/dir]] # alias available from Haxelib 4.2.0
```

--------------------------------

### haxelib remove [project-name]

Source: https://lib.haxe.org/documentation/using-haxelib

Removes all versions of the specified project from the local machine.

```bash
haxelib remove format
```

--------------------------------

### haxelib --never

Source: https://lib.haxe.org/documentation/using-haxelib

Answers all questions with no. Cannot be used at the same time as --always.

```bash
haxelib --never
```

--------------------------------

### Store compiler arguments in hxml file

Source: https://lib.haxe.org/documentation/haxelibs-in-projects

Stores the same compiler arguments in an hxml file, including the --library flag to include a Haxelib library.

```hxml
--main Main
--library libraryname
--js bin/main.js
```

--------------------------------

### Specify library version in OpenFL project.xml

Source: https://lib.haxe.org/documentation/haxelibs-in-projects

Specifies a version for a Haxe library in an OpenFL project.xml file using the version attribute.

```xml
<haxelib name="actuate" version="1.0.0" />
```

--------------------------------

### haxelib deleterepo

Source: https://lib.haxe.org/documentation/using-haxelib

Removes a local repository created with `haxelib newrepo` from the current directory, including all libraries contained in it.

```bash
haxelib deleterepo
```

--------------------------------

### haxelib convertxml

Source: https://lib.haxe.org/documentation/using-haxelib

Converts `haxelib.xml` from the current directory (Haxelib 2 XML specification) into `haxelib.json` for current Haxelib.

```bash
haxelib convertxml
```

--------------------------------

### Set a development directory with haxelib dev

Source: https://lib.haxe.org/documentation/using-haxelib

Sets a development directory for a project, which should contain a haxelib.json or source .hx files. Omit the directory to deactivate the dev version. Useful when developing a library and testing changes. Related to the HAXELIB_DEV_FILTER environment variable.

```bash
haxelib dev [project-name] [directory]
```

--------------------------------

### haxelib -notimeout

Source: https://lib.haxe.org/documentation/using-haxelib

Removes timeout when connecting to Haxelib server, downloading, or submitting a library. Note: before Haxelib 4.2.0, only `-notimeout` is recognized; `--notimeout` is not. Also affects `-cwd`.

```bash
haxelib -notimeout
haxelib --no-timeout # alias available from Haxelib 4.2.0
```
Tokens:
Raw