Skip to content

🚀 Quick start

Goal: installed binary → “oh, it edited my file” in about a minute. ⏱️ Secondary goal: smile at least once. 😄

Assumptions: you ran an install one-liner and have some model reachable (oMLX, Ollama, LM Studio, cloud…). No model? See Providers before yelling at the harness.


  1. 🔌 Point at a model === "🍎 oMLX"
    omlx start
    slmcode doctor
    
    Green doctor = green light. Red doctor = “have you tried turning the model on?” === "🦙 Ollama"
    ollama serve
    slmcode config set provider ollama
    slmcode config set model qwen2.5-coder:14b
    slmcode config set endpoint http://127.0.0.1:11434
    slmcode doctor
    
    === "🌌 Other" Flags, env, or Studio Settings — Providers. Bring your own brain.
  2. 🛝 Init a playground
    mkdir -p /tmp/slm-demo && cd /tmp/slm-demo
    printf 'package main\n\nfunc Hello() string { return "hi" }\n' > hello.go
    printf '# Agents\n\nPrefer tiny Go edits and clear godoc comments.\n' > AGENTS.md
    slmcode init
    
    Edit .slmcode/PROJECT.md with two honest sentences about the stack. (Lying to your own memory file is a bold strategy. We don’t recommend it.)
  3. 🎯 Run the pipeline
    slmcode run -v "Add a Go doc comment to Hello() explaining it returns a greeting. Keep it tiny."
    
    Pass checklist ✅ - [ ] hello.go has a real // Hello … comment - [ ] slmcode board shows completed work - [ ] slmcode session list has a run - [ ] .slmcode/SKILLS.md exists (the flywheel sneezed)
  4. 🕹️ Open a cockpit
    slmcode studio    # http://127.0.0.1:7420 — clicky mode
    # and/or
    slmcode           # premium TUI — keyboard mode
    
    Pick your fighter. Both talk to the same harness. 🥊

Level-ups 🎮

# Safer on real repos (stage first, apply later)
slmcode config set permission review
slmcode run -v "Add a unit test for Hello()"
slmcode apply

# Help small models think twice (literally)
slmcode config set think_passes 2
slmcode config set retries 2

# One specialist, no full circus
slmcode run --agent explorer "Where is Hello defined?"

🦃

Turkey rule reminder: tiny prompt, tiny scope, tiny win. If you ask a 7B model to “refactor the platform”, it will invent a platform.


Where next? 🗺️

  • 🧠 Concepts — why the loop looks like this
  • 🧭 User guide — daily driving without chaos
  • 🧪 Recipes — copy-paste workflows
  • 🖥️ TUI & chat — terminal UX deep dive

☀️ Made with ♥ by UnicoLab