edgeViewLauncher AGENTS.md

AGENTS.md

This file provides guidance to AI Agents (including WARP) when working with code in this repository.

Critical Rules

IMPORTANT:

1. NEVER DELETE KEYCHAIN ITEMS: You are strictly forbidden from deleting items from the user's keychain (e.g., via security delete-generic-password) unless explicitly and unambiguously instructed to do so by the user for a specific item.
2. NEVER create git tags or trigger release builds (CI/CD) unless explicitly instructed by the user.
3. ALWAYS work using PR process:
   • Create a new branch for every task or set of changes.
   • NEVER commit directly to the main or master branch.
   • Push your branch to the remote to facilitate PR creation.
4. Write meaningful commit messages:
   • Include decent human-readable comments describing the changes.
   • This ensures GitHub produces meaningful "What's changed" messages for every new release.
5. Do not modify eve/ directory contents as they are reference implementations.
6. ALWAYS run tests and build after modifying code to verify changes:
   • Check your current directory (pwd) before running commands.
   • If in project root (edgeViewLauncher/):
     • Frontend: npm run build:frontend (or cd frontend && npm run build)
     • Backend: go build -o edgeview-backend ./cmd/edgeview-backend
   • If in frontend directory (edgeViewLauncher/frontend/):
   • Frontend: npm run build (DO NOT run cd frontend again)
     • Backend: cd .. && go build -o edgeview-backend ./cmd/edgeview-backend
7. Commit Message Attribution:
   • DO NOT include the Co-Authored-By attribution line in commit messages.

Project Overview

EdgeView Launcher is a Tauri desktop application with a Go backend sidecar for managing remote ZEDEDA edge devices. It provides SSH terminal access, VNC remote desktop, and TCP tunneling through EdgeView proxy connections.

Architecture

┌──────────────────────────────────────────────────────────────────────────┐
│                             Tauri Core (Rust)                             │
│  src-tauri/src/main.rs                                                    │
│  - Spawns Go backend as sidecar (edgeview-backend)                        │
│  - Creates WebviewWindow, tray menu, native dialogs                       │
│  - Handles IPC commands (api_call, open_terminal_window)                  │
└─────────────────────────────┬────────────────────────────────────────────┘
                              │ IPC via invoke() / listen()
┌─────────────────────────────▼────────────────────────────────────────────┐
│                        Frontend (React + Vite)                            │
│  frontend/src/                                                            │
│  ├── App.jsx           – Main UI (search, settings, device details)      │
│  ├── tauriAPI.js       – Wraps Tauri commands for API calls              │
│  └── components/                                                          │
│      ├── TerminalView.jsx  – xterm.js WebSocket terminal                 │
│      └── VncViewer.jsx     – NoVNC remote desktop viewer                 │
└─────────────────────────────┬────────────────────────────────────────────┘
                              │ HTTP/WebSocket to localhost:<dynamic-port>
┌─────────────────────────────▼────────────────────────────────────────────┐
│                        Go Backend                                         │
│  http-server.go  – HTTP API routes, WebSocket SSH terminal handler       │
│  app.go          – Business logic, session management, ZEDEDA integration│
│                                                                           │
│  internal/                                                                │
│  ├── config/     – Cluster configuration persistence (~/.edgeview-config)│
│  ├── session/    – EdgeView session cache, TCP tunnel management         │
│  ├── ssh/        – SSH key generation and management                     │
│  └── zededa/     – ZEDEDA Cloud API client (devices, apps, EdgeView)     │
└──────────────────────────────────────────────────────────────────────────┘