Skip to content
Back to search

operon

AI-powered IDE for bioinformatics — built by biologists, for biologists

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

Its scripts were only partly scanned.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/swaruplab/operon with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/swaruplab/operon'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/swaruplab--operon/badge.svg)](/listings/swaruplab--operon)

HTML

<a href="/listings/swaruplab--operon"><img src="/api/listings/swaruplab--operon/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Download (Recommended)

The latest signed installers for every platform are on the [**GitHub Releases**](https://github.com/swaruplab/operon/releases/latest) page. A pre-built macOS DMG with notarization is also mirrored at [swaruplab.bio.uci.edu/operon](https://swaruplab.bio.uci.edu/operon).

| Platform | Installer | Notes | |---|---|---| | **macOS — Apple Silicon** | `Operon_<version>_aarch64.dmg` | Right-click → Open the first time to bypass Gatekeeper | | **macOS — Intel** | `Operon_<version>_x64.dmg` | Same Gatekeeper note | | **Windows** | `Operon_<version>_x64-setup.exe` (NSIS) or `Operon_<version>_x64_en-US.msi` | SmartScreen may flag the binary as "Unrecognized app" — click "More info → Run anyway" | | **Linux — Debian / Ubuntu** | `Operon_<version>_amd64.deb` | `sudo apt install ./Operon_*.deb` | | **Linux — Fedora / RHEL** | `Operon-<version>-1.x86_64.rpm` | `sudo dnf install ./Operon-*.rpm` | | **Linux — distro-agnostic** | `Operon_<version>_amd64.AppImage` | `chmod +x` then run directly |

Build from Source

<details> <summary><strong>Prerequisites by platform (click to expand)</strong></summary>

All platforms need **Node.js 18+**, **npm**, and **Rust** (via [rustup](https://rustup.rs/)). Additional native toolchain per OS:

| OS | Native toolchain | |---|---| | **macOS** | Xcode Command Line Tools — `xcode-select --install` | | **Windows** | [Visual Studio 2022 Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) with "Desktop development with C++"; [WebView2 runtime](https://developer.microsoft.com/microsoft-edge/webview2/) (pre-installed on Win 11) | | **Linux (Debian/Ubuntu)** | `sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev` | | **Linux (Fedora)** | `sudo dnf install webkit2gtk4.1-devel openssl-devel curl wget file libappindicator-gtk3-devel librsvg2-devel @"C Development Tools and Libraries"` |

</details>

# 1. Clone the repository
git clone https://github.com/swaruplab/operon.git
cd operon

# 2. Install frontend dependencies
npm install

# 3. Run in development mode (hot-reload)
npm run tauri dev

# 4. Build a production installer for your OS
npm run tauri build
# macOS  → src-tauri/target/release/bundle/{dmg,macos}/
# Win    → src-tauri/target/release/bundle/{msi,nsis}/
# Linux  → src-tauri/target/release/bundle/{deb,appimage,rpm}/

<details> <summary><strong>All development & build commands</strong></summary>

| Command | What it does | |---------|--------------| | `npm run tauri dev` | Start dev server with hot-reload | | `npm run build` | Build frontend only (TypeScript + Vite) | | `npm run tauri build` | Full production build for the current host OS | | `npm run build:mac:arm` | macOS Apple Silicon DMG | | `npm run build:mac:intel` | macOS Intel DMG | | `npm run build:mac:universal` | macOS universal binary (both arches) | | `npm run build:win` | Windows installers (NSIS + MSI) | | `npm run build:win:msi` | Windows MSI only | | `npm run build:win:nsis` | Windows NSIS (.exe) only | | `npm run build:linux` | Linux bundles (deb, AppImage, rpm) | | `npm run build:linux:deb` | Linux .deb only | | `npm run build:linux:appimage` | Linux AppImage only |

</details>

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 620 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <div align="center">
  2. # Operon
  3. **AI-powered IDE for bioinformatics — built by biologists, for biologists.**
  4. [![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
  5. [![Version](https://img.shields.io/github/v/release/swaruplab/operon?color=purple)](https://github.com/swaruplab/operon/releases/latest)
  6. [![macOS](https://img.shields.io/badge/macOS-12%2B-black.svg?logo=apple)](https://github.com/swaruplab/operon/releases/latest)
  7. [![Windows](https://img.shields.io/badge/Windows-10%2F11-0078D6.svg?logo=windows)](https://github.com/swaruplab/operon/releases/latest)
  8. [![Linux](https://img.shields.io/badge/Linux-deb%20%2F%20rpm%20%2F%20AppImage-FCC624.svg?logo=linux&logoColor=black)](https://github.com/swaruplab/operon/releases/latest)
  9. [![Tauri](https://img.shields.io/badge/Tauri_2-Rust_%2B_React-orange.svg)](https://tauri.app)
  10. [![Protocols](https://img.shields.io/badge/protocols-665-green.svg)](#analysis-protocols)
  11. Operon is a cross-platform desktop application that brings together an AI
  12. coding assistant (Claude), integrated terminal, code editor, file browser, and
  13. remote-server access into a single tool designed for computational biologists.
  14. Whether you're running RNA-seq pipelines on an HPC cluster from your Windows
  15. laptop, analyzing single-cell data on a Linux workstation, or writing scripts
  16. on a Mac, Operon gives you a professional development environment with AI that
  17. understands your domain.
  18. [**Download**](https://github.com/swaruplab/operon/releases/latest) •
  19. [**Documentation**](https://swaruplab.bio.uci.edu/operon) •
  20. [**Release notes**](https://github.com/swaruplab/operon/blob/cross-platform/CHANGELOG.md)
  21. <img src="docs/img/main-workspace.png" alt="Operon workspace" width="800">
  22. </div>
  23. ---
  24. ## Table of Contents
  25. - [Why Operon?](#why-operon)
  26. - [Features](#features)
  27. - [System Requirements](#system-requirements)
  28. - [Installation](#installation)
  29. - [Download (pre-built installers)](#download-recommended)
  30. - [Build from Source](#build-from-source)
  31. - [Getting Started](#getting-started)
  32. - [Setup Wizard](#setup-wizard)
  33. - [Authentication & AI Providers](#authentication--ai-providers)
  34. - [Using Operon](#using-operon)
  35. - [Workspace Overview](#workspace-overview)
  36. - [File Explorer](#file-explorer)
  37. - [Code Editor](#code-editor)
  38. - [Integrated Terminal](#integrated-terminal)
  39. - [AI Chat — Four Modes](#ai-chat--four-modes)
  40. - [Analysis Protocols](#analysis-protocols)
  41. - [PubMed Integration](#pubmed-integration)
  42. - [Light & Dark Theme](#light--dark-theme)
  43. - [Remote Server & HPC](#remote-server--hpc)
  44. - [SSH Connections](#ssh-connections)
  45. - [Running AI on Remote Clusters](#running-ai-on-remote-clusters)
  46. - [Git Integration](#git-integration)
  47. - [Keyboard Shortcuts](#keyboard-shortcuts)
  48. - [Settings & Customization](#settings--customization)
  49. - [Building for Distribution](#building-for-distribution)
  50. - [Project Architecture](#project-architecture)
  51. - [Contributing](#contributing)
  52. - [Help & Support](#help--support)
  53. - [License](#license)
  54. ---
  55. ## Why Operon?
  56. Most IDEs are built for software engineers. Operon is built for **you** — the
  57. biologist who writes Python scripts to process sequencing data, runs pipelines
  58. on a shared HPC cluster, and needs to search PubMed while debugging a Scanpy
  59. workflow. We built Operon because we needed it ourselves.
  60. <table>
  61. <tr>
  62. <td width="33%" valign="top">
  63. ### Built for Biology
  64. Understands bioinformatics file formats (FASTA, FASTQ, VCF, BAM, GFF),
  65. common pipelines, and domain-specific best practices out of the box.
  66. </td>
  67. <td width="33%" valign="top">
  68. ### Four AI Modes
  69. **Agent** executes multi-step tasks. **Plan** architects solutions.
  70. **Ask** answers questions — with optional PubMed search.
  71. **Report** produces a structured scientific writeup.
  72. </td>
  73. <td width="33%" valign="top">
  74. ### Remote HPC
  75. SSH into university clusters, browse remote files, run AI agents directly
  76. on compute nodes. Your data never leaves the server.
  77. </td>
  78. </tr>
  79. <tr>
  80. <td width="33%" valign="top">
  81. ### 665 Bundled Protocols
  82. Curated bio-first analysis protocols spanning scRNA-seq, spatial,
  83. chromatin, CRISPR, proteomics, drug discovery, and more. Create your own
  84. with AI or write them in Markdown.
  85. </td>
  86. <td width="33%" valign="top">
  87. ### Multi-Provider AI
  88. Anthropic direct, institutional **Portkey** gateways (e.g. UCI ZotGPT),
  89. or any OpenAI-compatible local backend (Ollama, vLLM, LM Studio) via a
  90. bundled translation proxy.
  91. </td>
  92. <td width="33%" valign="top">
  93. ### Native Performance
  94. Built with Tauri 2 (Rust + React). Tiny bundle, 20–40 MB RAM. Uses your
  95. system's native webview — not Electron. Ships for macOS, Windows, and
  96. Linux.
  97. </td>
  98. </tr>
  99. </table>
  100. ---
  101. ## System Requirements
  102. | Platform | Minimum |
  103. |---|---|
  104. | **macOS** | macOS 12 (Monterey) or later · Apple Silicon (M1+) or Intel |
  105. | **Windows** | Windows 10 (1809+) or Windows 11 · x64 · WebView2 runtime (pre-installed on Windows 11; auto-installed on 10) |
  106. | **Linux** | x64 · glibc 2.35+ **and** `webkit2gtk-4.1` (Ubuntu 22.04+ / Debian 12+ / Fedora 38+). RHEL/Rocky/AlmaLinux 8–9 and Debian 11 are **not** supported unless `webkit2gtk-4.1` is installed from EPEL/backports. See [Linux support matrix](#linux-support-matrix). |
  107. | **Disk** | ~500 MB including dependencies |
  108. | **RAM** | 4 GB minimum, 8 GB recommended |
  109. | **Internet** | Required for AI features and initial setup |
  110. > **Note:** Developer dependencies (Claude Code, build toolchains where needed)
  111. > are installed automatically by the setup wizard on first launch.
  112. ### Linux support matrix
  113. Operon's webview links against **`webkit2gtk-4.1`** (Tauri 2's required
  114. WebKit ABI), which is only shipped by newer distributions. The runtime floor is
  115. therefore **both**:
  116. - **glibc 2.35+** — Ubuntu 22.04+
  117. - **`webkit2gtk-4.1`** — Ubuntu 22.04+ / Debian 12+ / Fedora 38+
  118. | Distribution | Supported | Notes |
  119. |---|---|---|
  120. | Ubuntu 22.04 / 24.04 | ✅ | Reference platform |
  121. | Debian 12 (Bookworm) | ✅ | |
  122. | Fedora 38+ | ✅ | |
  123. | Debian 11 (Bullseye) | ❌ | Ships `webkit2gtk-4.0` only |
  124. | RHEL / Rocky / AlmaLinux 8–9 | ❌ | No `webkit2gtk-4.1` in base repos — install it from EPEL/backports to run |
  125. This floor applies to **all** Linux artifacts, including the AppImage. The
  126. AppImage does **not** bundle WebKit — `bundleMediaFramework` only bundles the
  127. GStreamer media stack, so the host must still provide `webkit2gtk-4.1`.
  128. ---
  129. ## Installation
  130. ### Download (Recommended)
  131. The latest signed installers for every platform are on the
  132. [**GitHub Releases**](https://github.com/swaruplab/operon/releases/latest) page.
  133. A pre-built macOS DMG with notarization is also mirrored at
  134. [swaruplab.bio.uci.edu/operon](https://swaruplab.bio.uci.edu/operon).
  135. | Platform | Installer | Notes |
  136. |---|---|---|
  137. | **macOS — Apple Silicon** | `Operon_<version>_aarch64.dmg` | Right-click → Open the first time to bypass Gatekeeper |
  138. | **macOS — Intel** | `Operon_<version>_x64.dmg` | Same Gatekeeper note |
  139. | **Windows** | `Operon_<version>_x64-setup.exe` (NSIS) or `Operon_<version>_x64_en-US.msi` | SmartScreen may flag the binary as "Unrecognized app" — click "More info → Run anyway" |
  140. | **Linux — Debian / Ubuntu** | `Operon_<version>_amd64.deb` | `sudo apt install ./Operon_*.deb` |
  141. | **Linux — Fedora / RHEL** | `Operon-<version>-1.x86_64.rpm` | `sudo dnf install ./Operon-*.rpm` |
  142. | **Linux — distro-agnostic** | `Operon_<version>_amd64.AppImage` | `chmod +x` then run directly |
  143. ### Build from Source
  144. <details>
  145. <summary><strong>Prerequisites by platform (click to expand)</strong></summary>
  146. All platforms need **Node.js 18+**, **npm**, and **Rust** (via [rustup](https://rustup.rs/)).
  147. Additional native toolchain per OS:
  148. | OS | Native toolchain |
  149. |---|---|
  150. | **macOS** | Xcode Command Line Tools — `xcode-select --install` |
  151. | **Windows** | [Visual Studio 2022 Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) with "Desktop development with C++"; [WebView2 runtime](https://developer.microsoft.com/microsoft-edge/webview2/) (pre-installed on Win 11) |
  152. | **Linux (Debian/Ubuntu)** | `sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev` |
  153. | **Linux (Fedora)** | `sudo dnf install webkit2gtk4.1-devel openssl-devel curl wget file libappindicator-gtk3-devel librsvg2-devel @"C Development Tools and Libraries"` |
  154. </details>
  155. ```bash
  156. # 1. Clone the repository
  157. git clone https://github.com/swaruplab/operon.git
  158. cd operon
  159. # 2. Install frontend dependencies
  160. npm install
  161. # 3. Run in development mode (hot-reload)
  162. npm run tauri dev
  163. # 4. Build a production installer for your OS
  164. npm run tauri build
  165. # macOS → src-tauri/target/release/bundle/{dmg,macos}/
  166. # Win → src-tauri/target/release/bundle/{msi,nsis}/
  167. # Linux → src-tauri/target/release/bundle/{deb,appimage,rpm}/
  168. ```
  169. <details>
  170. <summary><strong>All development & build commands</strong></summary>
  171. | Command | What it does |
  172. |---------|--------------|
  173. | `npm run tauri dev` | Start dev server with hot-reload |
  174. | `npm run build` | Build frontend only (TypeScript + Vite) |
  175. | `npm run tauri build` | Full production build for the current host OS |
  176. | `npm run build:mac:arm` | macOS Apple Silicon DMG |
  177. | `npm run build:mac:intel` | macOS Intel DMG |
  178. | `npm run build:mac:universal` | macOS universal binary (both arches) |
  179. | `npm run build:win` | Windows installers (NSIS + MSI) |
  180. | `npm run build:win:msi` | Windows MSI only |
  181. | `npm run build:win:nsis` | Windows NSIS (.exe) only |
  182. | `npm run build:linux` | Linux bundles (deb, AppImage, rpm) |
  183. | `npm run build:linux:deb` | Linux .deb only |
  184. | `npm run build:linux:appimage` | Linux AppImage only |
  185. </details>
  186. ---
  187. ## Getting Started
  188. ### Setup Wizard
  189. On first launch, Operon walks you through installing all dependencies automatically:
  190. | Step | What's installed |
  191. |------|------------------|
  192. | 1 | Native toolchain check (Xcode CLT on macOS, WebView2 on Windows, system libs on Linux) |
  193. | 2 | Claude Code (the AI engine) |
  194. | 3 | Optional: GitHub CLI, conda, common bioinformatics CLIs |
  195. <p align="center">
  196. <img src="docs/img/setup-welcome.png" alt="Setup wizard welcome" width="500">
  197. </p>
  198. ### Authentication & AI Providers
  199. Operon supports three provider backends, picked from **Settings → Auth → Provider**:
  200. | Provider | Use it for | How to authenticate |
  201. |---|---|---|
  202. | **Anthropic** (default) | Anthropic OAuth or a personal API key — talks directly to `api.anthropic.com` | "Log in with Claude" (browser OAuth) or paste an `sk-ant-...` key |
  203. | **Portkey** | Institutional gateways (UCI ZotGPT, Bedrock-backed Claude, cost-tracked routing). Anthropic-family models pass through Portkey's `/v1/messages`; non-Anthropic models (Moonshot Kimi, GPT, Gemini) are auto-routed through Operon's bundled translation proxy. | Paste a Portkey virtual key; pick a model from the auto-loaded catalog |
  204. | **Custom** | Any OpenAI-compatible local backend — Ollama, vLLM, LM Studio, llama.cpp server. Anthropic-format requests are translated to OpenAI Chat Completions by the bundled `anthropic-proxy` sidecar. | Enter the base URL (e.g. `http://localhost:11434/v1`); API key optional for most local backends |
  205. <p align="center">
  206. <img src="docs/img/auth-selection.png" alt="Provider selection in Settings → Auth" width="500">
  207. </p>
  208. ---
  209. ## Using Operon
  210. ### Workspace Overview
  211. The workspace has 5 main areas:
  212. | Area | Description |
  213. |------|-------------|
  214. | **Activity Bar** (left edge) | Switch between File Explorer, SSH, Git, Protocols, Help |
  215. | **Sidebar** | Context-sensitive panel for the active view |
  216. | **Editor** (center) | Monaco-based code editor with 30+ language support |
  217. | **Terminal** (bottom) | Integrated terminal with tab management |
  218. | **AI Chat** (right) | Claude conversation panel with streaming responses |
  219. <p align="center">
  220. <img src="docs/img/tour-workspace.png" alt="Workspace overview" width="800">
  221. </p>
  222. ### File Explorer
  223. - Tree view with lazy directory loading
  224. - Create, rename, delete files and folders
  225. - Go-to-folder path bar (`Cmd/Ctrl+G`)
  226. - Symlink-aware (local and remote)
  227. <p align="center">
  228. <img src="docs/img/file-explorer.png" alt="File explorer" width="300">
  229. </p>
  230. ### Code Editor
  231. - **Monaco Editor** — same engine as VS Code
  232. - 30+ languages with syntax highlighting
  233. - Custom `operon-dark` and `operon-light` themes
  234. - Side-by-side diff viewer with accept/reject
  235. - Image and PDF viewer with zoom & download
  236. ### Integrated Terminal
  237. - Full terminal emulator powered by **xterm.js**
  238. - Multiple tabs with independent sessions
  239. - Auto-copy on selection
  240. - WebGL rendering for performance
  241. - Preserves your shell aliases and conda environments
  242. - On Windows, Claude Code runs through bundled **Git Bash** so HPC-style
  243. Bash scripts work unchanged
  244. ### AI Chat — Four Modes
  245. | Mode | Purpose | Best For |
  246. |---|---|---|
  247. | **Agent** | Executes multi-step tasks autonomously | Writing scripts, running pipelines, debugging |
  248. | **Plan** | Generates an `implementation_plan.md` without executing; subsequent Agent runs track progress with `[x]` markers | Designing analysis workflows, architecture |
  249. | **Ask** | Conversational Q&A with optional PubMed search | Literature review, explaining concepts |
  250. | **Report** | Tool-restricted writeup mode that produces a structured methods/results section grounded in your project files | End-of-analysis reports, methods sections for papers |
  251. <p align="center">
  252. <img src="docs/img/tour-ai-modes.png" alt="AI modes" width="500">
  253. </p>
  254. ### Analysis Protocols
  255. Operon ships with **665 built-in protocols** organized into ~30 bio-first
  256. categories:
  257. <table>
  258. <tr>
  259. <td>
  260. - Single-cell (Scanpy, Seurat, scVI)
  261. - Spatial transcriptomics (Visium, MERFISH, Xenium)
  262. - Chromatin (ATAC, ChIP, CUT&Tag, Hi-C)
  263. - Bulk RNA-seq (DESeq2, edgeR, limma)
  264. - CRISPR screens (MAGeCK, CRISPResso)
  265. - Cytometry & immunology
  266. </td>
  267. <td>
  268. - Population genetics & variants (GWAS, eQTL)
  269. - Genome assembly & annotation
  270. - Proteomics & structural (AlphaFold, ESM)
  271. - Microbiome (16S, shotgun)
  272. - Liquid biopsy & cfDNA
  273. - Drug discovery & cheminformatics
  274. </td>
  275. <td>
  276. - Database agents: PubMed, GEO, KEGG,
  277. GTEx, UniProt, JASPAR, AlphaFold,
  278. bioRxiv, ClinicalTrials
  279. - Medical imaging & radiomics
  280. - Lab automation
  281. - Bio-aware coding agents
  282. </td>
  283. </tr>
  284. </table>
  285. When you select a protocol, its instructions are injected into Claude's
  286. context. Claude then follows domain-specific best practices for that
  287. analysis type.
  288. **Create your own protocols:**
  289. - **AI-Generated** — describe what you need in plain English and Claude writes
  290. the full protocol
  291. - **Manual** — write Markdown in the built-in editor
  292. - Stored in `~/.operon/protocols/` — shareable and version-controllable
  293. <p align="center">
  294. <img src="docs/img/protocols-list.png" alt="Protocols list" width="500">
  295. </p>
  296. ### PubMed Integration
  297. Toggle PubMed search in Ask mode. Claude searches NCBI's PubMed database,
  298. retrieves relevant papers, and incorporates findings with proper citations.
  299. No API key required — powered by NCBI E-utilities.
  300. <p align="center">
  301. <img src="docs/img/pubmed-toggle.png" alt="PubMed toggle" width="300">
  302. </p>
  303. ### Light & Dark Theme
  304. Toggle between **light** and **dark** themes from the top bar at any time.
  305. The switch propagates everywhere — UI chrome, Monaco editor, xterm terminal
  306. palette (WebGL atlas refresh included), and the native macOS title bar.
  307. <p align="center">
  308. <img src="docs/img/theme-toggle.png" alt="Light/dark theme toggle" width="500">
  309. </p>
  310. ---
  311. ## Remote Server & HPC
  312. ### SSH Connections
  313. Connect to remote servers and HPC clusters directly from Operon:
  314. - Password and SSH key authentication
  315. - **Duo/MFA support** for university clusters
  316. - SSH connection multiplexing (fast, fewer auth prompts)
  317. - Browse remote files, edit code, run commands
  318. - Set up SSH keys directly from the app
  319. <p align="center">
  320. <img src="docs/img/ssh-connect.png" alt="SSH connection" width="500">
  321. </p>
  322. ### Running AI on Remote Clusters
  323. Operon can install Claude Code on your remote server and run AI sessions
  324. directly on HPC infrastructure:
  325. - **Agent mode works over SSH** — executes commands, writes scripts, submits
  326. SLURM/PBS jobs on the remote machine
  327. - **Data never leaves the server** — only terminal I/O travels over SSH
  328. - Runs inside **tmux sessions** that persist across app restarts
  329. - Output files written to shared filesystem (not node-local `/tmp`)
  330. > **This is the killer feature for computational biologists:** run Claude
  331. > directly on your university's HPC cluster with access to your data,
  332. > your conda environments, and your SLURM queue.
  333. <p align="center">
  334. <img src="docs/img/tour-hpc.png" alt="HPC remote workflow" width="500">
  335. </p>
  336. ---
  337. ## Git Integration
  338. Built-in Git panel in the sidebar:
  339. - View changed files with staged/unstaged diffs
  340. - Stage, unstage, commit with messages
  341. - Push, pull, fetch from remote
  342. - Create and publish new repositories
  343. - Full GitHub workflow without leaving the app
  344. <p align="center">
  345. <img src="docs/img/git-panel.png" alt="Git panel" width="300">
  346. </p>
  347. ---
  348. ## Keyboard Shortcuts
  349. Modifier shorthand: `Cmd` on macOS, `Ctrl` on Windows/Linux.
  350. | Shortcut | Action |
  351. |----------|--------|
  352. | `Cmd/Ctrl+,` | Open Settings |
  353. | `Cmd/Ctrl+Shift+P` | Command Palette |
  354. | `Cmd/Ctrl+B` | Toggle Sidebar |
  355. | `Cmd/Ctrl+J` | Toggle Terminal |
  356. | `Cmd/Ctrl+Shift+J` | Toggle AI Chat |
  357. | `Cmd/Ctrl+N` | New Terminal Tab |
  358. | `Cmd/Ctrl+W` | Close Tab |
  359. | `Cmd/Ctrl+S` | Save File |
  360. | `Cmd/Ctrl+G` | Go to Folder |
  361. ---
  362. ## Settings & Customization
  363. Access via `Cmd/Ctrl+,` or the gear icon in the top bar.
  364. | Category | Options |
  365. |----------|---------|
  366. | **Editor** | Font size, tab size, word wrap, minimap, theme (`operon-dark` / `operon-light`) |
  367. | **Terminal** | Font size, cursor style, scrollback buffer |
  368. | **Claude** | Provider (Anthropic / Portkey / Custom), model selection, max turns, plan-mode toggle |
  369. | **Auth** | Anthropic OAuth or API key, Portkey virtual key, custom endpoint URL |
  370. | **Appearance** | Light / dark theme toggle (also accessible from the top bar) |
  371. <p align="center">
  372. <img src="docs/img/settings-panel.png" alt="Settings" width="500">
  373. </p>
  374. ---
  375. ## Building for Distribution
  376. The same `npm run build:<target>` scripts used in development produce signed
  377. artifacts when the appropriate signing credentials are present.
  378. ### macOS — signed & notarized DMGs
  379. ```bash
  380. cp build-signed.example.sh build-signed.sh
  381. # Edit build-signed.sh with your Apple Developer credentials
  382. bash build-signed.sh
  383. ```
  384. Three macOS templates are provided:
  385. | Template | Target |
  386. |---|---|
  387. | `build-signed.example.sh` | Apple Silicon DMG |
  388. | `build-intel.example.sh` | Intel DMG |
  389. | `build-universal.example.sh` | Universal binary (both architectures) |
  390. ### Windows & Linux
  391. The GitHub Actions [`Release` workflow](.github/workflows/release.yml) builds
  392. signed Windows installers (MSI + NSIS) and Linux bundles (`.deb`, `.rpm`,
  393. `.AppImage`) automatically on every `v*` tag push. Locally:
  394. ```bash
  395. npm run build:win # Windows: .msi + .exe
  396. npm run build:linux # Linux: .deb + .rpm + .AppImage
  397. ```
  398. ---
  399. ## Project Architecture
  400. ```
  401. operon/
  402. ├── src/ # React/TypeScript frontend
  403. │ ├── components/ # UI components
  404. │ │ ├── chat/ # AI chat panel with streaming, tool display
  405. │ │ ├── editor/ # Monaco editor, diff viewer, file viewer
  406. │ │ ├── terminal/ # xterm.js terminal with tab management
  407. │ │ ├── sidebar/ # File explorer, SSH, Git, Protocols, Help
  408. │ │ ├── layout/ # AppShell, TopBar, ActivityBar, StatusBar
  409. │ │ ├── settings/ # Settings panel
  410. │ │ └── setup/ # First-time setup wizard
  411. │ ├── context/ # React context (project state, editor tabs, theme)
  412. │ ├── hooks/ # Custom hooks (keyboard shortcuts)
  413. │ ├── lib/ # Typed IPC wrappers (claude, files, terminal, ssh, portkey)
  414. │ └── types/ # TypeScript type definitions
  415. ├── src-tauri/ # Rust backend (Tauri 2)
  416. │ ├── src/
  417. │ │ ├── main.rs # Entry point
  418. │ │ ├── lib.rs # Tauri builder, state managers, command registration
  419. │ │ └── commands/ # IPC command handlers (terminal, files, claude, ssh, settings, portkey, proxy)
  420. │ ├── binaries/ # Bundled sidecars (anthropic-proxy translation layer)
  421. │ └── icons/ # App icons (icns, png, ico)
  422. ├── protocols/ # 665 bundled bioinformatics protocols (Markdown)
  423. ├── presets/ # Hot-fetchable Portkey gateway presets
  424. ├── docs/ # Documentation website + images
  425. └── build-*.example.sh # macOS signed-build script templates (no credentials)
  426. ```
  427. ### Tech Stack
  428. | Layer | Technology |
  429. |-------|-----------|
  430. | **App Shell** | Tauri 2 (Rust) — small bundle, native webview |
  431. | **Frontend** | React 18 + TypeScript + Vite 6 |
  432. | **Terminal** | xterm.js + portable-pty (same stack as VS Code & WezTerm) |
  433. | **Editor** | Monaco Editor (VS Code's engine) |
  434. | **Layout** | react-resizable-panels |
  435. | **Styling** | Tailwind CSS 3 + lucide-react icons; CSS-variable themes |
  436. | **SSH** | OpenSSH sidecar via PTY (ProxyJump, agent forwarding, `~/.ssh/config`) |
  437. | **AI Engine** | Claude Code (headless NDJSON streaming) + bundled `anthropic-proxy-rs` for OpenAI-compatible backends |
  438. | **Provider Routing** | Anthropic direct · Portkey gateways · Custom OpenAI-compatible (Ollama / vLLM / LM Studio) |
  439. ---
  440. ## Contributing
  441. We welcome contributions from the bioinformatics community!
  442. **Branch model:**
  443. - **`cross-platform`** — active development and the default branch (PRs go here)
  444. - Release tags (`v0.7.x`) are cut directly from `cross-platform` and trigger
  445. the multi-OS Release workflow
  446. 1. Fork the repository
  447. 2. Create a feature branch off `cross-platform` (`git checkout -b feature/my-feature cross-platform`)
  448. 3. Make your changes
  449. 4. Run the dev server to test (`npm run tauri dev`)
  450. 5. Commit and push
  451. 6. Open a Pull Request targeting `cross-platform`
  452. ---
  453. ## Help & Support
  454. | Resource | Link |
  455. |----------|------|
  456. | **In-app Help** | Click the Help icon in the activity bar |
  457. | **Documentation** | [swaruplab.bio.uci.edu/operon](https://swaruplab.bio.uci.edu/operon) |
  458. | **Bug Reports** | [GitHub Issues](https://github.com/swaruplab/operon/issues) |
  459. | **Latest Downloads** | [GitHub Releases](https://github.com/swaruplab/operon/releases/latest) |
  460. | **Release Notes** | [CHANGELOG.md](./CHANGELOG.md) |
  461. <p align="center">
  462. <img src="docs/img/help-panel.png" alt="Help panel" width="500">
  463. </p>
  464. ---
  465. ## License
  466. MIT License — see [LICENSE](LICENSE) for details.
  467. <div align="center">
  468. Built with care by [Swarup Lab](https://github.com/swaruplab) at UC Irvine
  469. </div>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.