INSTALLATION GUIDE

Everything you need to get started with ContextCypher

Prerequisites Overview

Required for All Platforms

Node.js: Version 18.x or higher
npm: Version 10.8.2 or higher (comes with Node.js)
Modern Browser: Chrome, Edge, Firefox, or Safari
RAM: Minimum 8GB recommended
Disk Space: 500MB for installation

Platform-Specific Requirements

Windows

Windows 10/11 (64-bit), PowerShell 5.0+

macOS

macOS 10.15+, Xcode Command Line Tools

Linux

Ubuntu 20.04+, build-essential, Python 3.x

Step 1: Install Node.js

Windows Installation

Important: ContextCypher requires Node.js 18+ and npm 10.8.2+

1. Check if Node.js is already installed:
Open PowerShell and check your current version:
```
$node --version
```
If you get an error or version is below v18, continue to step 2
2. Download Node.js 18+ LTS:
Go to nodejs.org and download the LTS version
Make sure it's version 18 or higher (currently 20.x LTS)
3. Run the Installer:
Double-click the downloaded .msi file and follow these steps:
- • Click "Next" on the welcome screen
- • Accept the license agreement and click "Next"
- • Keep the default installation path and click "Next"
- • Important: Check "Automatically install the necessary tools" checkbox
- • Click "Next" then "Install" (requires administrator permission)
- • Click "Finish" when complete
- • Restart PowerShell after installation
4. Verify Installation:
In a new PowerShell window, verify the versions:
```
$node --version
```
Should display: v18.x.x or higher (e.g., v20.11.0)
```
$npm --version
```
Should display: 10.8.2 or higher
5. Update npm (if needed):
If npm version is below 10.8.2:
```
$npm install -g npm@latest
```

macOS Installation

Important: ContextCypher requires Node.js 18+ and npm 10.8.2+

1. Check if Node.js is already installed:
Open Terminal (Cmd+Space, type "Terminal") and check:
```
$node --version
```
If you get an error or version is below v18, continue to step 2
2. Install Xcode Command Line Tools (if needed):
Required for compiling native modules:
```
$xcode-select --install
```
Click "Install" in the popup (skip if already installed)
3. Install Node.js 18+:
Option A: Official Installer (Recommended)
- • Go to nodejs.org
- • Download the macOS Installer (.pkg file) - LTS version
- • Double-click the .pkg file
- • Follow the installation wizard
- • Restart Terminal after installation
Option B: Homebrew (if you have it):
```
$brew update
```
```
$brew install node@18
```
Or for latest LTS:
```
$brew install node
```
4. Verify Installation:
In a new Terminal window, check versions:
```
$node --version
```
Should display: v18.x.x or higher
```
$npm --version
```
Should display: 10.8.2 or higher
5. Update npm (if needed):
If npm version is below 10.8.2:
```
$sudo npm install -g npm@latest
```
Enter your Mac password when prompted

Linux Installation

Important: ContextCypher requires Node.js 18+ and npm 10.8.2+

1. Update Package Manager & Install curl:
Ubuntu/Debian:
```
$sudo apt update
```
If you don't have curl installed:
```
$sudo apt install curl
```
Fedora/RHEL:
```
$sudo dnf update
```
```
$sudo dnf install curl
```
2. Remove Old Node.js (if present):
Ubuntu/Debian:
```
$sudo apt remove nodejs npm
```
This ensures you get the correct version

3. Install Node.js 18+ via NodeSource:

Ubuntu/Debian (installs Node.js 18.x):

$curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -

$sudo apt-get install -y nodejs

Fedora/RHEL:

$sudo dnf module install nodejs:18/common

4. Install Build Tools:

Ubuntu/Debian:

$sudo apt-get install -y build-essential

Fedora/RHEL:

$sudo dnf groupinstall "Development Tools"

5. Verify Installation:
```
$node --version
```
Should show v18.x.x or higher
```
$npm --version
```
Should show 10.8.2 or higher

Step 2: Install ContextCypher

Global Installation (Recommended)

Windows (PowerShell):

$npm install -g @threatvectorsecurity/contextcypher

macOS/Linux:

$sudo npm install -g @threatvectorsecurity/contextcypher

Enter your password when prompted

Permission Error? If you get EACCES errors on macOS/Linux, you need sudo. On Windows, run PowerShell as Administrator.

Alternative: Local Installation

$npm install @threatvectorsecurity/contextcypher

Then run with: npx contextcypher

Step 3: Run ContextCypher

Default Start (Port 3002)

$contextcypher

This will:

• Start the server on port 3002
• Open your browser automatically
• Display the ContextCypher interface

Using a Different Port

If port 3002 is already in use, you can specify a different port:

Windows PowerShell:

$$env:PORT=3003; contextcypher

Or set for the session:

$$env:PORT=3003

$contextcypher

Windows Command Prompt:

$set PORT=3003 && contextcypher

Or set for the session:

$set PORT=3003

$contextcypher

macOS/Linux:

$PORT=3003 contextcypher

Or export for the session:

$export PORT=3003

$contextcypher

Note: The app will then be available at http://localhost:3002 (or your chosen port)