LinJun: Instructions file for Codex

AGENTS.md - linjun Development Guide

Instructions for AI coding agents working on this Electron + React + TypeScript codebase.

Project Overview

linjun is a cross-platform desktop application for managing CLIProxyAPI, built with:

• Electron 33+ - Desktop framework
• React 18 - UI library
• TypeScript 5 - Type safety
• Vite - Build tool (via electron-vite)
• Tailwind CSS - Styling

Build Commands

# Install dependencies
bun install

# Development mode (hot reload)
bun dev

# Build for production
bun run build

# Platform-specific builds
bun run build:mac      # macOS (dmg, zip)
bun run build:win      # Windows (nsis)
bun run build:linux    # Linux (AppImage, deb)
bun run build:all      # All platforms

# Download CLIProxyAPI binary
bun run download:binary

Lint & Format Commands

# Lint all files
bun run lint

# Lint with auto-fix
bun run lint:fix

# Format code with Prettier
bun run format

# Type check without emitting
bun run typecheck

Test Commands

# Run all tests
bun test

# Run tests in watch mode
bun run test:watch

# Run a single test file
bun test src/main/proxy/manager.test.ts

# Run tests matching a pattern
bun test -t "ProxyManager"

# Run with coverage
bun run test:coverage

Project Structure

src/
├── main/           # Electron main process (Node.js)
├── preload/        # Preload scripts (bridge)
└── renderer/       # React frontend (browser)

Code Style Guidelines

TypeScript

• Strict mode enabled - No any types unless absolutely necessary
• Explicit return types on exported functions
• Interface over type for object shapes
• Enums for fixed sets of values

// ✅ Good
interface ProxyStatus {
  running: boolean;
  port: number;
  uptime: number;
}

export function getStatus(): ProxyStatus {
  // ...
}

// ❌ Bad
export function getStatus(): any {
  // ...
}

Imports

Order imports in this sequence (with blank lines between groups):