Skip to content
On this page

CLI Overview

The lip CLI is the primary interface for managing packages. It provides commands for installing, updating, and managing dependencies.

Global Options

OptionDescription
-h, --helpShow help for lip or for a command (e.g. lip install --help).
-v, --versionPrint the version of lip.

lip without arguments opens the interactive interface when it runs in a terminal, and prints help otherwise (in a script or a pipe).

Some commands accept --json to print their result as JSON: config get, config list, daemon status and list. pkg view always prints JSON.

setup, install, uninstall and update install the packages of the platform win-x64 into the workspace, whatever system lip runs on (see Environment); the Linux server is the variant github.com/LiteLDev/bds#linux. setup chooses the game (the server) and the loader (LeviLamina) of the workspace; install and update never change them. lip manages server workspaces only.

Commands

Commands for running a server:

Every command except lip daemon is carried out by the daemon of lip, a background process of your user that the first command starts; it behaves exactly as if the lip you started carried it out. The command group daemon shows and stops it:

Commands for developing packages, in the command group pkg:

  • lip pkg init: Create a lip.toml for a new package.
  • lip pkg migrate: Migrate the tooth.json of lip v0.x in the current directory to lip.toml.
  • lip pkg pack: Pack a directory into a ZIP archive.
  • lip pkg view: Show the package file and the versions of a package.

lip pkg --help, lip cache --help, lip config --help and lip daemon --help show the commands of a group. Earlier versions of lip had lip init, lip pack, lip view, lip versions and lip migrate; they are now lip pkg init, lip pkg pack, lip pkg view (which also lists the versions) and lip pkg migrate.