A command-line interface for sending prompts to LM Studio loaded models
Project description
lmsp - LM Studio Prompt CLI
A simple command-line interface for sending prompts to LM Studio loaded models.
Features
- Send prompts to locally loaded LM Studio models
- Uses the first loaded model by default (or specify with
-m) - Requires pre-loaded models: Models must be loaded using
lms load <model>or LM Studio desktop app - Support for piping input from other commands
- Verbose logging with
-vflag for debugging - Simple and fast command-line interface
Installation
Quick Install from PyPI (Recommended)
# Install globally with pip
pip install lmsp
# Or install globally with uv (recommended)
uv tool install lmsp
Alternative Installation Methods
Install from source
# Using uv tool (recommended - installs globally)
uv tool install git+https://github.com/kmlawson/lmsp.git
# Or clone and install locally
git clone https://github.com/kmlawson/lmsp.git
cd lmsp
uv tool install .
Install in virtual environment
# Using uv
uv venv
source .venv/bin/activate
uv pip install lmsp
# Or using pip
python -m venv venv
source venv/bin/activate
pip install lmsp
Development installation
# Clone and install in development mode
git clone https://github.com/kmlawson/lmsp.git
cd lmsp
uv pip install -e . # or pip install -e .
Configuration
lmsp supports a configuration file to set default values for command-line options. The configuration file is located at ~/.lmsp-config and is automatically created with default values when you first run lmsp.
Configuration File Format
The configuration file uses JSON format:
{
"model": null,
"port": 1234,
"pipe_mode": "append",
"wait": false,
"stats": false,
"plain": false,
"verbose": false
}
Configuration Options
- model: Default model to use (null means use first loaded model)
- port: Default LM Studio server port (1234)
- pipe_mode: How to handle piped input ("replace", "append", or "prepend")
- wait: Disable streaming by default (false)
- stats: Show response statistics by default (false)
- plain: Disable markdown formatting by default (false)
- verbose: Enable verbose logging by default (false)
Example Custom Configuration
{
"model": "google/gemma-3n-e4b",
"port": 1234,
"pipe_mode": "append",
"wait": true,
"stats": true,
"plain": false,
"verbose": false
}
This configuration would:
- Use "google/gemma-3n-e4b" as the default model
- Wait for complete responses (no streaming) and beautify markdown output
- Show response statistics by default
- Append piped content to prompts
Command-line arguments always override configuration file settings.
Usage
Prerequisites
Before using lmsp, you need to load a model:
# Load a model using lms command
lms load google/gemma-3n-e4b
# Or use LM Studio desktop app to load a model
Basic usage
lmsp "What is the capital of France?"
Specify a model
# Use a specific model (must be already loaded)
lmsp -m llama-3.2-1b-instruct "Explain quantum computing"
# Enable verbose logging for debugging
lmsp -v -m google/gemma-3n-e4b "What is AI?"
Pipe input
# Simple piping - replaces the prompt
cat document.txt | lmsp
# Combine prompt with piped content (default appends)
cat document.txt | lmsp "Summarize this document:"
# Control how piped input is combined
cat context.txt | lmsp "Answer based on context:" --pipe-mode prepend
cat document.txt | lmsp "Summarize:" --pipe-mode append
# Real example: Translate a text to English
cat tests/testdata/test-text.md | lmsp "Please translate the following text to English:"
Check loaded models
# List currently loaded models
lmsp --list-models
# List all available models (not loaded)
lms ls
Check server status
lmsp --check-server
Get help
lmsp --help
# or lmsp -h
Security Considerations
When using lmsp, please be aware of the following security considerations:
Piped Content
- Be cautious about what content you pipe to
lmsp. The piped content is directly appended or prepended to your prompt without sanitization. - Avoid piping untrusted content or files from unknown sources
- Be especially careful when piping content that might contain prompt injection attempts or malicious instructions
- Example of what to avoid:
# Don't pipe untrusted user input or files cat untrusted_user_file.txt | lmsp "Summarize this:"
Model Selection
- Only use trusted models that you have intentionally loaded into LM Studio
- Be aware that models will execute the prompts you send, including any piped content
Local Usage
lmspis designed for local use with your own LM Studio instance- It connects to
localhostonly and does not expose any network services
Prerequisites
- LM Studio must be installed
- The LM Studio server must be running (
lms server start) - At least one model must be loaded (
lms load <model>)
Running Tests
python -m unittest tests.test_lmsp -v
Planned Features
- Ability to attach images with
-aflag for multi-modal models - Ability to continue from last prompt
- Enhanced piping support for documents
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file lmsp-0.5.7.tar.gz.
File metadata
- Download URL: lmsp-0.5.7.tar.gz
- Upload date:
- Size: 25.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
32d0d03b1d4fda4a63bfbc0112076cfc805de35f0d8afc1fd57544844267bd65
|
|
| MD5 |
9d2757492094554c5d4ef420e424497b
|
|
| BLAKE2b-256 |
576e92577ddfa14110176efd56932f0f1270f4f3a342f47c9e0427e3b0d3a09c
|
File details
Details for the file lmsp-0.5.7-py3-none-any.whl.
File metadata
- Download URL: lmsp-0.5.7-py3-none-any.whl
- Upload date:
- Size: 13.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1cee2a325eb9291ba4f4f7b8478c5b190e16a6970bd1b6a33d2a8e51f9cb7767
|
|
| MD5 |
865e8d0826d865b108b5c4c7b82f2b6d
|
|
| BLAKE2b-256 |
737b63dc14aee7287acca1fa6f80dfda55221a561347867291efd955c0ce2764
|