Help guides

Author: Luke Hinds

package-lock.json

@@ -18,13 +18,15 @@
     "@radix-ui/react-switch": "^1.1.1",
     "@radix-ui/react-tooltip": "^1.1.4",
     "@types/prismjs": "^1.26.5",
+    "@types/react-copy-to-clipboard": "^5.0.7",
     "@types/react-syntax-highlighter": "^15.5.13",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",
     "date-fns": "^4.1.0",
     "lucide-react": "^0.462.0",
     "prismjs": "^1.29.0",
     "react": "^18.3.1",
+    "react-copy-to-clipboard": "^5.1.0",
     "react-dom": "^18.3.1",
     "react-markdown": "^9.0.1",
     "react-router-dom": "^7.0.2",

package.json

@@ -1,62 +1,98 @@
 # Continue Setup Guide
 
-This guide will help you complete your setup process for CodeGate.
+First off all, you will need to install the Continue Extension. 
 
-## Prerequisites
+You can do this by running the following command:
 
-Before you begin, ensure you have:
-- Git installed on your system
-- Access to your repository
-- Required permissions
+```bash
+code --install-extension continue.continue
+```
 
-## Steps to Complete Setup
+Alternatively, you can install the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Continue.continue).
 
-### 1. Configure Repository Settings
 
-```bash
-# Clone your repository
-git clone https://github.com/your-org/your-repo.git
+Once you have installed the extension, you should be able to see the Continue icon in the Activity Bar.
 
-# Navigate to the repository
-cd your-repo
-```
+![Continue Icon](./images/continue.png)
 
-### 2. Set up Security Policies
+## Steps to Complete Setup
 
-Create a security policy file in your repository:
+### 1. Configure Continue
 
-```yaml
-# .codegate/security.yml
-policies:
-  dependency_scanning: enabled
-  vulnerability_checks: enabled
-  branch_protection: true
-```
+Within VSCode open the command palette and run the `Continue: New Sesstion`
 
-### 3. Define Workflow Rules
+This will bring up the Continue chat window. 
 
-Configure your workflow rules in the CodeGate dashboard:
+Select the cog icon in the top right corner to open the settings.
+
+Configure your LLM provider as per normal with Continue, but change the `apiBase`
+value as follows:
 
 ```json
 {
-  "workflow": {
-    "automated_checks": true,
-    "review_required": true,
-    "minimum_approvals": 2
+  "apiBase": "http://localhost:8989/openai",
   }
 }
 ```
 
-### 4. Review and Activate
+For example, to configure the Anthropic provider, you would use the following configuration:
+
+```json
+{
+  "title": "anthropic claude-3-5-sonnet",
+  "provider": "anthropic",
+  "model": "claude-3-5-sonnet-20241022",
+  "apiKey": "yourkey",
+  "apiBase": "http://localhost:8989/anthropic"
+},
+```
+
+The same follows for OpenAI, Ollama, vLLM and any other provider you wish to use.
 
-Once configured, activate your settings:
+```json
+"models": [
+    {
+      "title": "vllm-qwen2.5-coder-14b-instruct",
+      "provider": "vllm",
+      "model": "Qwen/Qwen2.5-Coder-14B-Instruct",
+      "apiKey": "key",
+      "apiBase": "http://localhost:8989/vllm"
+    },
+    {
+      "title": "openai",
+      "provider": "openrouter",
+      "model": "gpt-4o-2024-11-20",
+      "apiBase": "http://localhost:8989/openai",
+      "apiKey": "key"
+    },
+    {
+      "title": "anthropic claude-3-5-sonnet",
+      "provider": "anthropic",
+      "model": "claude-3-5-sonnet-20241022",
+      "apiKey": "key",
+      "apiBase": "http://localhost:8989/anthropic"
+    },
+    {
+      "title": "ollama qwen2.5-coder-7b-instruct",
+      "provider": "ollama",
+      "model": "sammcj/qwen2.5-coder-7b-instruct:q8_0",
+      "apiBase": "http://localhost:8989/ollama"
+    }
+  ],
+```
 
-```bash
-# Verify configuration
-codegate verify
+For auto completion, you can add the following to your settings.json file:
 
-# Activate settings
-codegate activate
+```json
+"tabAutocompleteModel": {
+  "title": "ollama",
+  "provider": "ollama",
+  "model": "codellama:7b-code",
+  "apiBase": "http://127.0.0.1:8989/ollama"
+},
 ```
 
-For detailed instructions on each step, please refer to our documentation.
+You can now start using Continue as before, but with the added benefit
+extra privacy and control over your data.
+
+![Continue Window](./images/continue-two.png)

public/help/continue-setup.md

@@ -1,75 +1,76 @@
-# CoPilot Setup Guide
+# 🤖 CoPilot Setup Guide
 
-This guide will help you set up and configure CoPilot integration with CodeGate.
+Welcome to the setup guide for configuring CoPilot integration with **CodeGate**. 
 
-## Prerequisites
 
-Before proceeding, ensure you have:
-- Active GitHub account
-- GitHub CoPilot subscription
-- CodeGate account
+---
 
-## Setup Instructions
+## 📋 Prerequisites
 
-### 1. Enable GitHub CoPilot
+Before you begin, make sure you have the following:
+- ✅ An active GitHub account
+- ✅ A GitHub CoPilot subscription
+- ✅ A CodeGate account
 
-First, activate CoPilot in your GitHub account:
+---
 
-```javascript
-// Example of CoPilot suggestions in your code
-function calculateRisk(dependencies) {
-  // CoPilot will suggest security checks
-  return dependencies.map(dep => {
-    return {
-      name: dep.name,
-      version: dep.version,
-      riskScore: analyzeRisk(dep)
-    }
-  });
-}
+## 🛠️ Setup Instructions
+
+### Install the CodeGate CA
+
+To enable CodeGate, you’ll need to install its Certificate Authority (CA) into your operating system’s trust store.
+
+> **Why is this needed?**  
+> The CodeGate CA allows your machine to securely intercept and modify traffic between GitHub CoPilot and your IDE.  
+> ✨ **Don’t worry!** The decrypted traffic stays on your local machine and never leaves.
+
+
+#### 🍎 **For MacOS Users**
+
+Run the following command in your terminal to install the CA:
+
+```bash
+sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain codegate_volume/certs/ca.crt
 ```
 
-### 2. Configure CoPilot Settings
+#### 🖥️ For Windows Users
 
-Add CoPilot configuration to your project:
+Use this PowerShell command:
 
-```json
-{
-  "copilot": {
-    "enabled": true,
-    "suggestions": {
-      "security": true,
-      "dependencies": true,
-      "codeReview": true
-    }
-  }
-}
+```Powershell
+Import-Certificate -FilePath "certs\\ca.crt" -CertStoreLocation Cert:\\LocalMachine\\Root
 ```
 
-### 3. Link GitHub Account
+#### 🐧 For Linux Users
 
-Connect your GitHub account using the following:
+Run these commands to install the CA:
 
 ```bash
-# Initialize CodeGate CoPilot integration
-codegate copilot init
-
-# Link your GitHub account
-codegate copilot link --github
+sudo cp certs/ca.crt /usr/local/share/ca-certificates/codegate.crt
+sudo update-ca-certificates
 ```
 
-### 4. Verify Integration
+    Note: You might need to restart your IDE after adding the certicates
 
-Test the integration with:
+### Configure CoPilot Settings to Use CodeGate
 
-```python
-# Python example of CoPilot integration
-def verify_copilot():
-    status = check_connection()
-    if status.ok:
-        print("CoPilot integration successful!")
-    else:
-        raise Exception("Integration failed")
+Update your CoPilot configuration to use CodeGate as a proxy. Add the following to your project configuration:
+
+```json
+{
+  "http.proxy": "https://localhost:8990",
+  "http.proxyStrictSSL": true,
+  "http.proxySupport": "on",
+  "github.copilot.advanced": {
+    "debug.useNodeFetcher": true,
+    "debug.useElectronFetcher": true,
+    "debug.testOverrideProxyUrl": "https://localhost:8990",
+    "debug.overrideProxyUrl": "https://localhost:8990
+  }
 ```
 
-For more detailed information, please consult our documentation.
+### Start Coding with the Privacy Protections and Security of CodeGate in place
+
+That’s it—you’re all set! 
+
+Go forth and build something amazing! 🚀✨