https://github.com/lmstudio-ai/lms

LM Studio CLI
https://github.com/lmstudio-ai/lms

llm lmstudio nodejs typescript

Last synced: 4 days ago
JSON representation

LM Studio CLI

• Host: GitHub
• URL: https://github.com/lmstudio-ai/lms
• Owner: lmstudio-ai
• License: mit
• Created: 2024-04-15T15:04:41.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T22:07:08.000Z (12 days ago)
• Last Synced: 2024-10-30T00:39:19.468Z (12 days ago)
• Topics: llm, lmstudio, nodejs, typescript
• Language: TypeScript
• Homepage: https://lms.dev
• Size: 170 KB
• Stars: 1,542
• Watchers: 22
• Forks: 131
• Open Issues: 55
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• StarryDivineSky - lmstudio-ai/lms
• awesome-repositories - lmstudio-ai/lms - 👾 LM Studio CLI (TypeScript)

README

        


  


   

    

    

    

  

  


  




lms - Command Line Tool for LM Studio

Built with lmstudio.js


# Installation

`lms` ships with [LM Studio](https://lmstudio.ai/) 0.2.22 and newer.

To set it up, run the built-in `bootstrap` command like so:

- **Windows**:

  ```shell

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

  ```

- **Linux/macOS**:

  ```shell

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

  ```

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

```shell

lms

```

# Usage

You can use `lms --help` to see a list of all available subcommands.

For details about each subcommand, run `lms  --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  --gpu max -y` - To load a model with maximum GPU acceleration without confirmation

- `lms unload ` - To unload a model

  - `lms unload --all` - To unload all models

- `lms create` - To create a new project with LM Studio SDK

- `lms log stream` - To stream logs from LM Studio