Skip to content

Update INSTALLATION-GUIDE.md for v3.0 #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kilo-code-bot wants to merge 2 commits into
base: main
Choose a base branch
from
+30 −63
Open

Update INSTALLATION-GUIDE.md for v3.0 #25

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
160a86d
docs: update INSTALLATION-GUIDE.md for v3.0
Apr 3, 2026
83c0031
Merge branch 'gt/maple/76b60560'
Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 30 additions & 63 deletions docs/INSTALLATION-GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Context Manager - Installation Guide

**Version:** 2.3.6+
**Last Updated:** November 3, 2025
**Version:** 3.0.0+
**Last Updated:** April 3, 2026

---

Expand All @@ -11,9 +11,8 @@
2. [Platform-Specific Installation](#platform-specific-installation)
3. [Package Managers](#package-managers)
4. [Verification](#verification)
5. [Optional Dependencies](#optional-dependencies)
6. [Uninstallation](#uninstallation)
7. [Troubleshooting](#troubleshooting)
5. [Uninstallation](#uninstallation)
6. [Troubleshooting](#troubleshooting)

---

Expand All @@ -32,11 +31,13 @@ context-manager --help
### One-Line Installers

#### macOS / Linux

```bash
bash <(curl -fsSL https://raw.githubusercontent.com/hakkisagdic/context-manager/main/scripts/install.sh)
```

#### Windows (PowerShell)

```powershell
irm https://raw.githubusercontent.com/hakkisagdic/context-manager/main/scripts/install.ps1 | iex
```
Expand All @@ -48,6 +49,7 @@ irm https://raw.githubusercontent.com/hakkisagdic/context-manager/main/scripts/i
### macOS

#### Option 1: Homebrew (Recommended)

```bash
# Add tap (once)
brew tap hakkisagdic/context-manager
Expand All @@ -60,61 +62,70 @@ brew upgrade context-manager
```

#### Option 2: NPM

```bash
npm install -g @hakkisagdic/context-manager
```

#### Option 3: Installation Script

```bash
curl -fsSL https://raw.githubusercontent.com/hakkisagdic/context-manager/main/scripts/install.sh | bash
```

### Linux

#### Option 1: Debian/Ubuntu (APT)

```bash
# Download DEB package
wget https://github.com/hakkisagdic/context-manager/releases/download/v2.3.5/context-manager_2.3.5_all.deb
wget https://github.com/hakkisagdic/context-manager/releases/download/v3.0.0/context-manager_3.0.0_all.deb

# Install
sudo dpkg -i context-manager_2.3.5_all.deb
sudo dpkg -i context-manager_3.0.0_all.deb

# Install dependencies if needed
sudo apt-get install -f
```

#### Option 2: Red Hat/Fedora (YUM/DNF)

```bash
# Coming soon - RPM package
# For now, use NPM:
npm install -g @hakkisagdic/context-manager
```

#### Option 3: NPM (Universal)

```bash
npm install -g @hakkisagdic/context-manager
```

#### Option 4: Installation Script

```bash
curl -fsSL https://raw.githubusercontent.com/hakkisagdic/context-manager/main/scripts/install.sh | bash
```

### Windows

#### Option 1: NPM (Recommended)

```powershell
npm install -g @hakkisagdic/context-manager
```

#### Option 2: PowerShell Script

```powershell
# Run as Administrator
Set-ExecutionPolicy Bypass -Scope Process -Force
irm https://raw.githubusercontent.com/hakkisagdic/context-manager/main/scripts/install.ps1 | iex
```

#### Option 3: Manual Download

1. Download from: https://github.com/hakkisagdic/context-manager/releases
2. Extract to: `C:\Program Files\context-manager`
3. Add to PATH: `C:\Program Files\context-manager\bin`
Expand All @@ -133,7 +144,7 @@ npm install -g @hakkisagdic/context-manager
npm install @hakkisagdic/context-manager

# Specific version
npm install -g @hakkisagdic/context-manager@2.3.5
npm install -g @hakkisagdic/context-manager@3.0.0

# Insider/pre-release
npm install -g @hakkisagdic/context-manager@next
Expand Down Expand Up @@ -220,49 +231,6 @@ context-manager convert test.json --from json --to toon

---

## 🎨 Optional Dependencies

Context Manager has **optional interactive features** that require additional dependencies.

### Interactive Wizard & Dashboard

These features use React + Ink for beautiful terminal UI:

```bash
# Install interactive dependencies
npm install -g ink react ink-select-input ink-text-input ink-spinner

# Or with the package
npm install -g @hakkisagdic/context-manager
```

**Features Enabled:**
- ✨ Interactive Wizard (`--wizard`)
- 📊 Live Dashboard (`--dashboard`)
- 🎨 Progress bars and spinners
- ⌨️ Keyboard navigation

**Without these dependencies:**
- Tool still works perfectly
- Uses simple text-based output
- All core features available

### Exact Token Counting

For exact GPT-4 token counting (optional):

```bash
npm install -g tiktoken
```

**With tiktoken:**
- ✅ Exact token counts (100% accuracy)

**Without tiktoken:**
- ✅ Smart estimation (~95% accuracy)

---

## 🗑️ Uninstallation

### macOS / Linux
Expand Down Expand Up @@ -305,6 +273,7 @@ Remove-Item -Path $env:USERPROFILE\.context-manager -Recurse
### "command not found: context-manager"

**Solution:**

```bash
# Check PATH
echo $PATH
Expand All @@ -317,6 +286,7 @@ source ~/.bashrc # or ~/.zshrc
### Permission Denied

**Linux/macOS:**

```bash
# Use sudo for global install
sudo npm install -g @hakkisagdic/context-manager
Expand All @@ -326,6 +296,7 @@ npm install @hakkisagdic/context-manager
```

**Windows:**

```powershell
# Run PowerShell as Administrator
```
Expand All @@ -352,16 +323,6 @@ npm cache clean --force
npm install -g @hakkisagdic/context-manager
```

### Wizard/Dashboard Not Working

```bash
# Install interactive dependencies
npm install -g ink react ink-select-input ink-text-input ink-spinner

# Or use simple mode
context-manager --simple
```

---

## 🔄 Updating
Expand All @@ -386,7 +347,7 @@ context-manager update rollback
npm update -g @hakkisagdic/context-manager

# Update to specific version
npm install -g @hakkisagdic/context-manager@2.3.6
npm install -g @hakkisagdic/context-manager@3.0.0
```

### Homebrew
Expand All @@ -400,30 +361,36 @@ brew upgrade context-manager
## 🎯 Installation Types

### Global Installation

```bash
npm install -g @hakkisagdic/context-manager
```

✅ Available system-wide
✅ Use from any directory
✅ Simple `context-manager` command
❌ Requires admin/sudo (sometimes)

### Local Installation

```bash
npm install @hakkisagdic/context-manager
```

✅ No admin rights needed
✅ Project-specific version
❌ Use via `npx` or npm scripts
❌ Not in system PATH

### Source Installation (Developers)

```bash
git clone https://github.com/hakkisagdic/context-manager.git
cd context-manager
npm install
npm link # Make globally available
```

✅ Latest development version
✅ Easy to contribute
❌ Manual updates required
Expand All @@ -450,6 +417,6 @@ After installation:

---

**Version:** 2.3.6+
**Version:** 3.0.0+
**Maintainer:** Hakkı Sağdıç
**License:** MIT
Loading