Documentation Index
Fetch the complete documentation index at: https://mintlify.com/warengonzaga/tinyclaw/llms.txt
Use this file to discover all available pages before exploring further.
Frequently Asked Questions
Find answers to common questions about Tiny Claw, from getting started to advanced usage.Getting Started
What is Tiny Claw?
What is Tiny Claw?
- Native - built from scratch, not wrapped around other frameworks
- Tiny - minimal core with plugin architecture
- Personal - has its own personality and treats you as a friend
- Affordable - smart routing cuts LLM costs by tiering queries
How is Tiny Claw different from other AI frameworks?
How is Tiny Claw different from other AI frameworks?
| Feature | Tiny Claw | Others |
|---|---|---|
| Built | From scratch | On existing frameworks |
| Core | Tiny, plugin-based | Large monolith |
| Personality | Fixed, unique character | Fully configurable |
| Memory | Self-improving with temporal decay | Flat conversation history |
| Cost | Smart routing tiers queries | Every query hits expensive models |
| Setup | Self-configuring | Complex multi-step onboarding |
| Runtime | Bun-native | Node.js + multiple dependencies |
Do I need coding experience to use Tiny Claw?
Do I need coding experience to use Tiny Claw?
- Basic usage: No coding required. Install and start chatting via the web UI.
- Plugin development: Basic JavaScript/TypeScript knowledge helpful but not required - we provide templates.
- Advanced customization: TypeScript experience recommended for core contributions.
What are the system requirements?
What are the system requirements?
- Runtime: Bun (latest stable version)
- OS: Linux, macOS, or Windows (WSL2 recommended)
- Storage: ~100MB for base installation
- Memory: 512MB minimum, 2GB recommended
- API Keys: Ollama Cloud account (free tier available) or your own provider API keys
Setup & Configuration
How do I install Tiny Claw?
How do I install Tiny Claw?
Can I use my own LLM provider?
Can I use my own LLM provider?
- Built-in: Ollama Cloud (default, free tier available)
- Plugin support: OpenAI, Anthropic, and more via provider plugins
- Custom: Build your own provider plugin
What models does Tiny Claw support?
What models does Tiny Claw support?
kimi-k2.5:cloud(default)gpt-oss:120b-cloud
- OpenAI: GPT-4, GPT-3.5, etc.
- Anthropic: Claude 3.5 Sonnet, Claude 3 Opus, etc.
- Any OpenAI-compatible API
Where is my data stored?
Where is my data stored?
- Database: SQLite (location:
~/.tinyclaw/tinyclaw.db) - Conversations: Encrypted with your session key
- Secrets: AES-256-GCM encryption via the secrets engine
- No cloud sync: Your data never leaves your machine unless you explicitly use a cloud provider for LLM queries
Features & Usage
What is Heartware and can I customize it?
What is Heartware and can I customize it?
- SOUL.md: Core personality, values, and behavioral patterns
- IDENTITY.md: Self-awareness and personal context
- SHIELD.md: Security policies and threat detection
How does the memory system work?
How does the memory system work?
- Episodic Memory: Stores conversation events with temporal decay
- Semantic Memory: Full-text search (FTS5) for knowledge retrieval
- Temporal Decay: Automatically forgets less important information over time
What is smart routing and how does it save money?
What is smart routing and how does it save money?
- Simple queries → Cheap/free models (e.g., GPT-3.5, local models)
- Complex queries → Powerful models (e.g., Claude 3.5 Sonnet, GPT-4)
Can Tiny Claw work with multiple communication channels?
Can Tiny Claw work with multiple communication channels?
- Built-in: Web UI (Discord-like interface)
- Plugin support: Discord, Slack, Telegram, CLI, and more
- Custom: Build your own channel plugin
What is the delegation system?
What is the delegation system?
- Self-improving role templates: Agent learns better delegation patterns
- Blackboard collaboration: Shared state between parent and child agents
- Adaptive timeout estimation: Learns how long tasks take
Plugins & Extensibility
How do I install plugins?
How do I install plugins?
- Built-in plugins: Automatically available
- Community plugins: Install from npm or GitHub
- Custom plugins: Drop into
plugins/directory
How do I create my own plugin?
How do I create my own plugin?
- Choose your plugin type (channel, provider, or tool)
- Use our plugin template
- Implement the required interface
- Test locally
- Publish (optional)
Can I publish and share my plugins?
Can I publish and share my plugins?
Troubleshooting
Tiny Claw won't start. What should I check?
Tiny Claw won't start. What should I check?
- Check Bun version: Run
bun --version(should be latest stable) - Verify installation: Run
bun installin the project directory - Check port availability: Default port 3000 might be in use
- Review logs: Check
~/.tinyclaw/logs/for error messages - Permission issues: Ensure write access to
~/.tinyclaw/
The agent isn't responding. What's wrong?
The agent isn't responding. What's wrong?
- Check provider status: Verify your LLM provider API is accessible
- API key validity: Ensure your API keys are correct and active
- Network connectivity: Test your internet connection
- Rate limits: You may have hit provider rate limits
- Check logs: Review console output for error messages
My messages are being rejected or filtered
My messages are being rejected or filtered
- Malicious patterns detected: Your message triggered security filters
- Prompt injection attempt: Detected attempt to override personality
- Unsafe actions: Request violates safety policies
The agent forgot our previous conversation
The agent forgot our previous conversation
- Less important memories fade over time
- Conversation context is compacted after a certain size
- Semantic memory retains key facts even when episodic memory fades
How do I reset or start fresh?
How do I reset or start fresh?
Cost & Licensing
Is Tiny Claw free to use?
Is Tiny Claw free to use?
- Personal use: Completely free
- Contributions: Welcome and encouraged
- Commercial use: Requires commercial license (contact for pricing)
- Ollama Cloud: Generous free tier, pay-as-you-go beyond that
- Other providers: Your own API costs apply
Does Tiny Claw have a cryptocurrency token?
Does Tiny Claw have a cryptocurrency token?
What's the dual-licensing model?
What's the dual-licensing model?
- GPL-3.0: Free for personal, educational, and non-commercial use
- Commercial License: Required for commercial products/services
Community & Support
How do I contribute to Tiny Claw?
How do I contribute to Tiny Claw?
- Read the Contributing Guide
- Check open issues
- Join discussions
- Submit PRs to the
devbranch
Where can I get help?
Where can I get help?
- Documentation: Start here! Most questions are answered in the docs
- GitHub Issues: Bug reports and feature requests
- GitHub Discussions: General questions and community support
- X/Twitter: Follow @TinyClawAI and @warengonzaga
Can I use Tiny Claw for my business?
Can I use Tiny Claw for my business?
- Commercial use in products/services
- White-label deployments
- Custom development and support
- Enterprise features