lip install

Install packages into the workspace.

Synopsis

lip install <PACKAGES>... [--accept-eula] [-n | --dry-run] [-h | --help]

Description

lip install installs each of <PACKAGES>, with its dependencies, into the workspace, as one workspace operation. Each of <PACKAGES> is a package argument:

A <repo> without / is a repository of LiteLDev: LeviLamina is github.com/LiteLDev/LeviLamina.

What it does:

• The packages you name become explicitly installed. One that was installed as a dependency becomes explicitly installed too.
• The dependencies of the packages are installed as dependency packages.
• An installed package keeps its version when that still works. Otherwise a dependency package may change version.
• Dependency packages that no explicitly installed package needs any more are uninstalled.

What it refuses, before anything changes:

• A package argument that is invalid, or names no package for the side server and the platform win-x64.
• A package that is already explicitly installed. Use lip update to change its version.
• Two arguments that name the same package.
• A set of packages that cannot be installed together, such as two mods with the same mod name, or dependencies that no version satisfies.
• Anything that would change the game or the loader. See below.

The version of a package installed from @branch:, @tag: or @rev: is the version in its lip.toml at that commit. Such a package also satisfies dependencies on the same repository and variant, when its version is in their range.

The game and the loader

The game and the loader are the installed packages of github.com/LiteLDev/bds and github.com/LiteLDev/LeviLamina; see lip setup.

lip install never installs, uninstalls or replaces the game or the loader, except as Setting up with install says. When the packages cannot be installed with them as they are, for example when a mod needs a newer LeviLamina, the command fails and names the game version, the loader version and lip setup. Set up a game and a loader that the mod supports with lip setup, then install the mod.

In a workspace that has no game, lip install fails and points to lip setup when a package you name, or one that it would install, is a mod, the server or LeviLamina. File packages that need none of them can be installed without a game.

Setting up with install

An argument names the server when it is github.com/LiteLDev/bds, with or without a variant or ref. An argument names the loader when it is github.com/LiteLDev/LeviLamina without a variant, and without a ref or with @<version>. Both are compared ignoring case.

When an argument names the server or the loader, lip install is carried out as a lip setup, together with the other arguments, in one operation:

Two arguments that name the server, or two that name the loader, fail the command. Everything that lip setup says holds: the license question, --accept-eula, left-out packages and the system dependencies.

Options

Output

lip install has no result: it writes nothing to standard output. Progress and the final line are messages on standard error. The hook commands of the packages write to standard output and standard error themselves.

Exit status

Examples

Install a mod from its repository, at its newest version:

lip install github.com/LiteLDev/LegacyScriptEngine#lua

Install a given version, and see first what it would do:

lip install github.com/user/repo@1.0.0 --dry-run
lip install github.com/user/repo@1.0.0

Install several packages in one operation:

lip install github.com/user/repo github.com/user/other@2.1.0

Install from a branch, a URL, a ZIP file and a directory:

lip install github.com/user/repo@branch:main
lip install https://example.com/package.zip
lip install ./package.zip
lip install ../MyTool

Set up a server and install a mod in one step, in a script:

lip install LeviLamina github.com/user/repo --accept-eula

See also

• Managing packages
• Get mods: finding and installing mods in the interface.
• lip setup, lip update, lip uninstall, lip list
• lip.toml: what a package is.