44485c4c72
- Update package description and fix mainProgram typo - Rewrite documentation to describe project switching, not process viewing - Add PROJECT_FOLDERS configuration and usage examples - Update all references across docs (README, guides, module overviews)
173 lines
3.2 KiB
Markdown
173 lines
3.2 KiB
Markdown
# msty-studio
|
||
|
||
Msty Studio enables advanced, privacy‑preserving AI workflows entirely on your local machine.
|
||
|
||
## Description
|
||
|
||
Msty Studio is a desktop application that provides a powerful AI development environment with a focus on privacy. All AI processing happens locally on your machine, ensuring your data never leaves your system.
|
||
|
||
## Features
|
||
|
||
- 🔒 **Privacy-First**: All AI processing happens locally
|
||
- 🤖 **Local AI Models**: Support for running local LLMs
|
||
- 📝 **Code Editor**: Integrated development environment
|
||
- 🔄 **Multiple Models**: Switch between different AI models
|
||
- 📊 **Model Management**: Download and manage local models
|
||
- 🎨 **Modern UI**: Clean, intuitive interface
|
||
- ⚡ **Fast Performance**: Optimized for speed
|
||
|
||
## Installation
|
||
|
||
### Via Overlay
|
||
|
||
```nix
|
||
{pkgs, ...}: {
|
||
environment.systemPackages = with pkgs; [
|
||
msty-studio
|
||
];
|
||
}
|
||
```
|
||
|
||
### Direct Reference
|
||
|
||
```nix
|
||
{pkgs, ...}: {
|
||
environment.systemPackages = with pkgs; [
|
||
inputs.m3ta-nixpkgs.packages.${pkgs.system}.msty-studio
|
||
];
|
||
}
|
||
```
|
||
|
||
### Run Directly
|
||
|
||
```bash
|
||
nix run git+https://code.m3ta.dev/m3tam3re/nixpkgs#msty-studio
|
||
```
|
||
|
||
## Usage
|
||
|
||
### Launch Application
|
||
|
||
```bash
|
||
# Launch Msty Studio
|
||
msty-studio
|
||
|
||
# Or from application menu
|
||
# Applications -> Msty Studio
|
||
```
|
||
|
||
### First Run
|
||
|
||
On first launch, you'll need to:
|
||
|
||
1. Download an AI model (if not already downloaded)
|
||
2. Configure model settings
|
||
3. Set up your workspace
|
||
|
||
### Managing Models
|
||
|
||
Through the Msty Studio interface, you can:
|
||
|
||
- Download new models
|
||
- Remove unused models
|
||
- Switch between models
|
||
- Configure model parameters
|
||
|
||
## Configuration
|
||
|
||
### Model Directory
|
||
|
||
Models are stored in your home directory:
|
||
|
||
```
|
||
~/.local/share/msty-studio/models/
|
||
```
|
||
|
||
### Settings
|
||
|
||
Msty Studio stores settings in:
|
||
|
||
```
|
||
~/.config/msty-studio/
|
||
```
|
||
|
||
### Integration with Nix
|
||
|
||
The package includes required dependencies:
|
||
|
||
- Node.js (for runtime)
|
||
- npm (for package management)
|
||
- uv (for Python packages)
|
||
- Python (for AI models)
|
||
|
||
## Requirements
|
||
|
||
### System Requirements
|
||
|
||
- Linux (x86_64)
|
||
- 8GB RAM minimum (16GB+ recommended)
|
||
- Modern CPU with AVX2 support
|
||
- GPU recommended (for faster inference)
|
||
|
||
### Dependencies
|
||
|
||
The package includes these dependencies:
|
||
|
||
- `nodejs` - JavaScript runtime
|
||
- `nodePackages.npm` - Package manager
|
||
- `uv` - Python package installer
|
||
- `python3` - Python runtime
|
||
|
||
## Platform Support
|
||
|
||
- Linux (x86_64 only)
|
||
- macOS (not supported)
|
||
- Windows (not supported)
|
||
|
||
**Note**: Msty Studio is distributed as an AppImage for Linux.
|
||
|
||
## Build Information
|
||
|
||
- **Version**: 2.0.0-beta.4
|
||
- **Type**: AppImage
|
||
- **License**: Proprietary (Unfree)
|
||
- **Source**: [msty.studio](https://msty.studio)
|
||
|
||
## Troubleshooting
|
||
|
||
### AppImage Won't Launch
|
||
|
||
Ensure executable bit is set:
|
||
|
||
```bash
|
||
chmod +x ~/.local/share/applications/msty-studio.desktop
|
||
```
|
||
|
||
### Models Not Downloading
|
||
|
||
Check disk space and network:
|
||
|
||
```bash
|
||
# Check disk space
|
||
df -h
|
||
|
||
# Check network
|
||
ping google.com
|
||
```
|
||
|
||
### Performance Issues
|
||
|
||
- Ensure you're using a GPU-accelerated model
|
||
- Close other resource-intensive applications
|
||
- Check system resources:
|
||
|
||
```bash
|
||
htop
|
||
nvidia-smi # If using NVIDIA GPU
|
||
```
|
||
|
||
## Related
|
||
|
||
- [Adding Packages](../guides/adding-packages.md) - How to add new packages
|
||
- [Quick Start](../QUICKSTART.md) - Getting started guide
|