Skip to content

START.md

Latest commit

 

History

History
115 lines (87 loc) · 2.46 KB

START.md

File metadata and controls

115 lines (87 loc) · 2.46 KB
Raw

🚀 Start Simple Signal CLI - Easy Commands

First Time Setup (Run Once)

1. Install Dependencies

pip install -r requirements.txt

2. Test Installation (Optional)

python test_install.py

Quick Start Commands

🎯 Option 1: Run with Automatic Model Selection (NEW!)

python ai_cli.py

Starts the CLI and automatically shows a model selector if LM Studio is running! Choose from available models with your keyboard.

Option 2: Run in Demo Mode (No Model Required)

python ai_cli.py --skip-selector

Starts the CLI with a demo interface - no AI model needed. Use --skip-selector to skip the model selector.

Option 3: Run with a Pre-installed Model

MODEL_PATH="Qwen/Qwen2.5-0.5B-Instruct" python ai_cli.py --skip-selector

Loads a real AI model for actual inference. Use --skip-selector to skip the interactive menu.

Option 4: Use the Windows Launcher (Batch File)

run.bat

Automatically detects if you have a MODEL_PATH set and starts accordingly.

Option 3: Use the Windows Launcher (Batch File)

run.bat

Automatically detects if you have a MODEL_PATH set and starts accordingly.

Option 4: Use PowerShell Launcher

.\run.ps1

Using Environment Variables

Set Model Path in Command Prompt

set MODEL_PATH="Qwen/Qwen2.5-0.5B-Instruct"
python ai_cli.py "%MODEL_PATH%"

Create .env File (Optional)

copy .env.example .env
notepad .env

Edit .env to set your preferred MODEL_PATH permanently.

Quick Chat Commands (Inside the CLI)

Once running, try these messages:

  • Hello! - Greet the AI
  • What can you do? - See capabilities
  • Tell me a joke - Get entertainment
  • Help me write code - Get coding assistance
  • quit, exit, or q - Exit the application

Troubleshooting

"python is not recognized"

# Try using py instead
py ai_cli.py

"No module named 'transformers'"

pip install -r requirements.txt

GPU Acceleration (Optional)

pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118

Summary of All Start Commands

Command Description
python ai_cli.py Start demo mode (no model)
MODEL_PATH="..." python ai_cli.py Start with specific model
run.bat Windows batch launcher
.\run.ps1 PowerShell launcher

Enjoy your local AI assistant! 🎉