@threatvectorsecurity/contextcypher
v1.5.1
Published
ContextCypher - AI-Powered Threat Modeling Platform
Downloads
26
Maintainers
Readme
ContextCypher
AI-Powered Threat Modeling and Security Analysis Platform
Overview
ContextCypher is a powerful, privacy-focused threat modeling platform that helps security professionals and developers create system architecture diagrams and generate AI-powered security threat analysis. It operates entirely offline by default using local LLMs (Ollama) or can connect to cloud AI providers.
Key Features
- Privacy-First: Works completely offline with local AI models
- Multiple AI Providers: Ollama (local), OpenAI, Anthropic Claude, Google Gemini
- Visual Threat Modeling: Create and analyze architecture diagrams
- MITRE ATT&CK Mapping: Automatic threat categorization (Pro)
- 25+ Premium Themes: Professional visualization options (Pro)
- 3D Security Visualization: Immersive isometric view of your architecture (Pro)
- Compliance Ready: Full audit logging capabilities (Pro)
Installation
Prerequisites
- Node.js 18.x or later (Download)
- npm 10.8.2 or later (comes with Node.js)
Install via npm
# Install globally
npm install -g @threatvectorsecurity/contextcypher
# Or with yarn
yarn global add @threatvectorsecurity/contextcypherUsage
Starting the Application
# Start ContextCypher
contextcypher
# The application will:
# 1. Start the backend server on port 3002
# 2. Open your browser automatically
# 3. Display the welcome screenFirst-Time Setup
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)
Install Ollama (for offline AI)
# macOS/Linux curl -fsSL https://ollama.com/install.sh | sh # Windows # Download from https://ollama.com/download # Pull a model ollama pull llama3.2
Command Line Options
# Start with custom port
contextcypher --port 3003
# Start without opening browser
contextcypher --no-browser
# Show version
contextcypher --version
# Show help
contextcypher --helpFeatures
Free Version
- 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
Pro Version
- AI diagram generation from text
- Advanced threat analysis with MITRE ATT&CK
- Premium themes and visual effects
- 3D Security Visualization - Immersive isometric view
- Automatic data sanitization
- Compliance logging and audit trails
- Full conversation history
System Requirements
Minimum Requirements
- 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+
For Local AI (Ollama)
- RAM: 8-16GB additional
- Storage: 10-20GB for models
- GPU: 8GB+ VRAM (recommended)
Troubleshooting
Common Issues
Port Already in Use
# 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 3003Ollama Connection Failed
# Ensure Ollama is running
ollama serve
# Check Ollama is accessible
curl http://localhost:11434/api/tagsPermission Denied (macOS/Linux)
# Fix npm global permissions
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrcLogs
Application logs are stored in:
- Windows:
%LOCALAPPDATA%\ContextCypher\logs\ - macOS:
~/Library/Application Support/ContextCypher/logs/ - Linux:
~/.config/ContextCypher/logs/
Updates
# 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/contextcypherSupport
- 💬 Discord: Join our community
- 🌐 Website: Threat Vector Security/
- 📖 Documentation: Installation Guide
- 🐛 Support & Issues: Contact Form
License
ContextCypher is proprietary software. By using this software, you agree to our Terms of Service.
Security
For security issues, please use our Contact Form and mark it as a security issue.
Legal Notice
NO WARRANTY: This software is provided "AS IS" without warranty of any kind. AI-generated content must be validated by security professionals. Not a substitute for professional security assessments.
By using ContextCypher, you agree to our Terms of Service and Privacy Policy.
Built with ❤️ by Threat Vector Security Pty Ltd
