Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 2.32 KB

README.md

File metadata and controls

60 lines (44 loc) · 2.32 KB
Raw


lmstudio cli logo

lms - Command Line Tool for LM Studio

Installation

lms ships with LM Studio. To set it up:

Set up lms (CLI)

lms is the CLI tool for LM Studio. It is shipped with the latest versions of LM Studio. To set it up, run the following command:

  • Windows:

    cmd /c %USERPROFILE%/.cache/lm-studio/bin/lms.exe bootstrap

  • Linux/macOS:

    ~/.cache/lm-studio/bin/lms bootstrap

To check if the bootstrapping was successful, run the following in a new terminal window:

lms

Usage

You can use lms --help to see a list of all available subcommands. For specific details about each subcommand, use lms <subcommand> --help.

Here are some frequently used commands:

  • lms status - To check the status of LM Studio.
  • lms server start - To start the local API server.
  • lms server stop - To stop the local API server.
  • lms ls - To list all downloaded models.
    • lms ls --detailed - To list all downloaded models with detailed information.
    • lms ls --json - To list all downloaded models in machine-readable JSON format.
  • lms ps - To list all loaded models available for inferencing.
    • lms ps --json - To list all loaded models available for inferencing in machine-readable JSON format.
  • lms load --gpu max - To load a model with maximum GPU acceleration
    • lms load <model path> --gpu max -y - To load a model with maximum GPU acceleration without confirmation
  • lms unload <model identifier> - To unload a model
    • lms unload --all - To unload all models
  • lms create - To create a new project with LM Studio SDK

Please note that most commands, except those controlling the server, internally use lmstudio.js. Therefore, ensure the server is running before utilizing these commands. You can start the server using lms server start.