Installation
TypeScript / JavaScript
bash
npm install smolvmRequires Node.js 18.0.0 or later.
Python
bash
pip install smolvmRequires Python 3.10 or later.
Server Setup
The SDK connects to a smolvm server. Start one locally:
bash
# Install smolvm CLI
curl -sSL https://smolmachines.com/install.sh | sh
# Start the server
smolvm serveThe server runs at http://127.0.0.1:8080 by default.
Platform Requirements
macOS
- macOS 11.0 (Big Sur) or later
- Apple Silicon (M1/M2/M3)
Linux
- Linux kernel 5.4+ with KVM support
- User must have access to
/dev/kvm
bash
# Check KVM access
ls -la /dev/kvm
# If needed, add yourself to the kvm group
sudo usermod -aG kvm $USER
# Then log out and back inVerify Installation
typescript
import { SmolvmClient } from 'smolvm';
const client = new SmolvmClient();
const health = await client.health();
console.log('Server status:', health.status);python
from smolvm import SmolvmClient
async def check():
client = SmolvmClient()
health = await client.health()
print(f"Server status: {health.status}")