Skip to main content

Getting Started with Soul Kernel

Build your first AI companion in 10 minutes! 🚀

What You’ll Build

A simple “Hello Soul” application that:
  • Creates a Soul with basic personality
  • Responds to user input
  • Remembers previous interactions
  • Functions as a digital twin that could sync across devices

Prerequisites

  • Rust installed (setup guide)
  • Basic terminal knowledge
  • 10 minutes of your time

Step 1: Install Soul Kernel

Step 2: Create Your First Soul

Create a new file my-first-soul.toml:

Step 3: Write Hello Soul

Create examples/hello-soul.rs:

Step 4: Run Your Soul

Expected output:

Step 5: Make It Interactive

Create examples/chat-soul.rs:

Step 6: Use the gRPC API (Optional)

Want to integrate Soul Kernel into other languages or remote applications? Use the gRPC API!

Start the gRPC Server

Connect from Any Language

Python Example:
JavaScript Example:

Run the Demo Client

We include a full demo client:
See the gRPC API Reference for complete documentation.

What’s Next?

🎯 Try These Challenges

  1. Add Emotions: Make your Soul respond with different emotions
  2. Add Memory: Have your Soul remember user preferences
  3. Add Skills: Enable vision or voice capabilities

📚 Learn More

🏗️ Build Something Real

Ready for more? Check out these tutorials:
  1. iOS Companion App - Mobile AI friend
  2. Unity NPC - Game character with personality
  3. Physical AI Assistant - Physical embodiment

Common Issues

”Soul not responding”

  • Check if the kernel is running: cargo run
  • Verify config file path is correct
  • Enable debug logs: RUST_LOG=debug cargo run

”Memory not persisting”

  • Change memory type from “ephemeral” to “persistent”
  • Specify a data directory in config

”Skill not found”

  • Ensure skill is listed in [skills] section
  • Check if skill binary is in PATH

Join the Community

Share Your Creation!

Built something cool? We’d love to see it!
  • Tag us on Twitter: @SoulKernel
  • Share in Discord: #showcase channel
  • Submit a PR with your example
Happy Soul building! 🎉

Change Log