Getting Started
Installation
From Source
go install github.com/rainmana/tinybrain/cmd/server@latest
Docker
docker pull rainmana/tinybrain:latest
docker run -p 8080:8080 rainmana/tinybrain
Pre-built Binaries
Download from Releases
Basic Usage
1. Start the Server
tinybrain-server --config config.json
2. Create a Session
curl -X POST http://localhost:8080/sessions \
-H "Content-Type: application/json" \
-d '{
"name": "Security Assessment",
"task_type": "penetration_test",
"intelligence_type": "osint"
}'
3. Store Intelligence
curl -X POST http://localhost:8080/memory \
-H "Content-Type: application/json" \
-d '{
"session_id": "session-id",
"title": "OSINT Finding",
"content": "Social media analysis reveals...",
"category": "intelligence",
"intelligence_type": "osint",
"threat_level": "medium"
}'
Configuration
Basic Configuration
Create a config.json
file:
{
"database": {
"path": "./tinybrain.db",
"max_connections": 10
},
"server": {
"host": "localhost",
"port": 8080
},
"security": {
"classification_levels": ["unclassified", "confidential", "secret"],
"threat_levels": ["low", "medium", "high", "critical"]
}
}
Environment Variables
export TINYBRAIN_DB_PATH="./tinybrain.db"
export TINYBRAIN_HOST="localhost"
export TINYBRAIN_PORT="8080"
Next Steps
- Core Features - Learn about memory management and sessions
- Intelligence & Reconnaissance - Explore intelligence gathering capabilities
- API Reference - Complete API documentation