Skip to content

Update README with server configuration details #448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abdulazizalmalki-gh wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

Update README with server configuration details #448

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,23 @@ lms

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

## Server Configuration

By default, the LMS server only accepts connections from localhost (`127.0.0.1`). To serve to your local network:

```bash
lms server start --bind 0.0.0.0
```

For details about each subcommand, run `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.
- Use `--bind 0.0.0.0` to serve to the local network (default: localhost only)
- Use `--port <port>` to specify a custom port
- Use `--cors` to enable CORS for web development
- `lms server stop` - To stop the local API server.
- `lms ls` - To list all downloaded models.
- `lms ls --json` - To list all downloaded models in machine-readable JSON format.
Expand Down