jross365 / lmstudio-client

A feature-rich Powershell console client for LMStudio

LMStudio-Client

A feature-rich LMStudio console client for Powershell.

Current Version: 0.5.4 Last Code Update: 08/17/2024

Features:

• Use LMStudio chat from any computer on your network!

• Records and saves LLM chat dialogs locally

  • Built-in file management, indexing (search will be included)
  • Resume and continue previous dialogs
  • Search the contents of your chat history

• Persistent configuration management:

  • Settings are preserved in a configuration file
  • Settings can be modified and saved easily

• And more!

  • Seriously, there's a lot of functionality built into this module.
  • What these are and how to use them will be included in the documentation.

Documentation

This module contains a lightweight C# HTTP client to provide the response streaming. The C# code requires .Net Framework 4.5 or greater.

The Quick-Start Guide is a no-frills and no-explanations guide on getting the module up and running.

It assumes several prerequisites:

• LM Studio is running
• The LM Studio web server is started in the software

The Full User Guide is an index of short articles on how to use the module.

The User Guide documentation is in the process of being written. Anything below "🚧 Below in progress:" is not complete.

I maintain a Development Journal to record and track my priorities, and to rationalize my design decisions.

It may be dry to some, and not dry to others.

Last Update was August 17, 2024.

Notes/Addendum:

07/18/2024 I have created the PSD1 file so these functions can be imported as a proper Powershell module. See the dev journal for details.

07/07/2024 The current version of the code does not work with Powershell 5. I will attempt to resolve this issue, and I'm not sure when it was first introduced. This issue is caused by the use of the clean {} block in Powershell, which I learned was only introduced in 7.3.

I've commented out the clean {} block (for now).