README.md

metadata

sdk: docker

🎨 Pencilclaw v1.0 - Hugging Face Space

A C++ command-line creative writing tool powered by local Ollama

✨ Features

• 📖 Story & Poem Generation
• 📚 Book Continuation
• ⚙️ Code Execution
• 📝 Session Logging
• 🔒 Private & Offline AI

🚀 Quick Start

1. Deploy this Space on Hugging Face
2. Wait for Docker build to complete
3. Use the interface to write stories, poems, or execute code

📋 Commands

Command	Description
/HELP	Show help message
/STORY <title>	Generate a short story
/POEM <subject>	Compose a poem
/BOOK <chapter>	Continue a book
/EXECUTE	Run AI-generated C++ code
/DEBUG	Toggle verbose output
/EXIT	Quit the session

🛠️ Requirements

• Ollama with model (default: qwen2.5:0.5b)
• libcurl development libraries
• cJSON library

🔒 Security

• Code execution requires confirmation
• Filename sanitization prevents path traversal
• All files isolated in pencil_data/ directory

📜 License

MIT License