ContextCypher - AI-Powered Threat Modeling Platform
bash
Install globally
npm install -g @threatvectorsecurity/contextcypher
Or with yarn
yarn global add @threatvectorsecurity/contextcypher
`
Usage
$3
`bash
Start ContextCypher
contextcypher
The application will:
1. Start the backend server on port 3002
2. Open your browser automatically
3. Display the welcome screen
`
$3
1. Configure AI Provider
- Open Settings (gear icon)
- Choose your AI provider:
- Ollama (recommended for offline use)
- OpenAI (requires API key)
- Anthropic Claude (requires API key)
- Google Gemini (requires API key)
2. Install Ollama (for offline AI)
`bash
# macOS/Linux
curl -fsSL https://ollama.com/install.sh | sh
# Windows
# Download from https://ollama.com/download
# Pull a model
ollama pull llama3.2
`
$3
`bash
Start with custom port
contextcypher --port 3003
Start without opening browser
contextcypher --no-browser
Show version
contextcypher --version
Show help
contextcypher --help
`
Features
$3
- Full diagram creation and editing
- All node types and security zones
- Chat-based diagram analysis
- Save/load diagrams (JSON format)
- Local Ollama for complete offline analysis
- Works with OpenAI, Anthropic and Google Gemini
- 3D Diagram Visualization - Immersive isometric view
$3
- AI diagram generation from text
- Advanced threat analysis with MITRE ATT&CK
- Premium themes and visual effects
- Automatic data sanitization
- Compliance logging and audit trails
- Full conversation history
System Requirements
$3
- OS: Windows 10+, macOS 10.15+, Ubuntu 20.04+
- RAM: 4GB (8GB recommended)
- Storage: 1GB free space
- Browser: Chrome 95+, Firefox 91+, Safari 15.4+, Edge 95+
$3
- RAM: 8-16GB additional
- Storage: 10-20GB for models
- GPU: 8GB+ VRAM (recommended)
Troubleshooting
$3
Port Already in Use
`bash
Find process using port 3002
lsof -i :3002 # macOS/Linux
netstat -ano | findstr :3002 # Windows
Kill the process or use a different port
contextcypher --port 3003
`
Ollama Connection Failed
`bash
Ensure Ollama is running
ollama serve
Check Ollama is accessible
curl http://localhost:11434/api/tags
`
Permission Denied (macOS/Linux)
`bash
Fix npm global permissions
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
`
$3
Application logs are stored in:
- Windows: %LOCALAPPDATA%\ContextCypher\logs\
- macOS: ~/Library/Application Support/ContextCypher/logs/
- Linux: ~/.config/ContextCypher/logs/
Updates
`bash
Check current version
contextcypher --version
Update to latest version
npm update -g @threatvectorsecurity/contextcypher
Or reinstall
npm uninstall -g @threatvectorsecurity/contextcypher
npm install -g @threatvectorsecurity/contextcypher
``