https://github.com/mrdjohnson/lmstudiojs-sidekick
https://github.com/mrdjohnson/lmstudiojs-sidekick
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/mrdjohnson/lmstudiojs-sidekick
- Owner: mrdjohnson
- License: apache-2.0
- Created: 2024-07-14T12:15:32.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T13:55:58.000Z (almost 2 years ago)
- Last Synced: 2024-07-25T15:57:39.164Z (almost 2 years ago)
- Language: TypeScript
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lmstudiojs-sidekick
#### Created with LM Studio scaffold: node-typescript
Welcome to your new project! This scaffold is a starting point for building an AI-enabled Node.js project with [LM Studio](https://lmstudio.ai/) SDK. To interact with LM Studio, you should start the LM Studio local server with the command:
```bash
lms server start
```
## Running the sidekick
### Terminal:
To prepare your project for production, compile the TypeScript code to JavaScript using:
```bash
npm run dev
```
### Docker:
You'll need to change `127.0.0.1` to `host.docker.internal` otherwise the client will not be able to connect (This is a replacement for localhost)
```bash
docker-compose up -d
```
- GET /v1/models returns open ai compatible data for ALL models, as well as if they're loaded
- POST /api/load loads the requested "model"
- POST /api/unload unloads the requested "model"
- POST /v1/completions open ai compatible completion endpoint, includes the load progress and stats for a generation (does not work with images)