Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yagil authored Apr 26, 2024
1 parent 15cf75f commit 21e68ec
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@

# Installation

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

## Set up `lms` (CLI)

`lms` is the CLI tool for LM Studio. It is shipped with the latest versions of [LM Studio](https://lmstudio.ai/). To set it up, run the following command:
To set it up, run the built-in `bootstrap` command like so:

- **Windows**:

Expand All @@ -31,15 +29,17 @@
~/.cache/lm-studio/bin/lms bootstrap
```

To check if the bootstrapping was successful, run the following in a new terminal window:
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 specific details about each subcommand, use `lms <subcommand> --help`.
You can use `lms --help` to see a list of all available subcommands.

For details about each **subcommand**, run `lms <subcommand> --help`.

Here are some frequently used commands:

Expand All @@ -57,4 +57,6 @@ Here are some frequently used commands:
- `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](https://github.com/lmstudio-ai/lmstudio.js). Therefore, ensure the server is running before utilizing these commands. You can start the server using `lms server start`.
Please note that most commands, except those controlling the server, internally use [lmstudio.js](https://github.com/lmstudio-ai/lmstudio.js). Therefore, ensure the API server is running before utilizing these commands.

You can start the API server using `lms server start`.

0 comments on commit 21e68ec

Please sign in to comment.