fluxor: Instructions file for Codex

AGENTS.md

fluxor AGENTS.md is an instructions file for Codex, OpenCode from shuangji66/fluxor. It costs 5,562 tokens per session, scanned A, original, Apache-2.0.

A project instruction file for Fluxor, a Go-based control panel and subscription generator for the Mihomo network-proxy engine. It explains the project structure, frontend versions, build process, communication paths, and maintenance rules.

In plain words
What is it for?
It is for guiding work on Fluxor’s Go backend, Vue or plain-JavaScript frontend, proxy communication, configuration generation, builds, and bug fixes.
Why use it?
It gives a coding agent the project context and constraints it needs to make changes safely in an unfamiliar codebase.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md.

This is shuangji66/fluxor's own configuration. It tells Codex and OpenCode how to work on fluxor itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything fluxor configures →

Reuse

Borrowing it

Nothing to install: this file belongs to shuangji66/fluxor. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/shuangji66/fluxor/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/shuangji66/fluxor

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for fluxor AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/shuangji66/fluxor/agents-md.svg)](https://agentmods.dev/instructions/shuangji66/fluxor/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/shuangji66/fluxor/agents-md"><img src="https://agentmods.dev/badge/instructions/shuangji66/fluxor/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 5,562 This file is loaded in full into every session.
When invoked 5,562 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.05562 $0.05562
Opus 5 $0.02781 $0.02781
Sonnet 5 $0.01112 $0.01112
Haiku 4.5 $0.00556 $0.00556

Measured 8d ago against content hash 99124bb58c9d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

fluxor AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 233 lines

How it starts

The opening of the file, as written. The whole thing — 233 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Fluxor 项目 AI 代理指南 (AGENTS.md)

本文件为后续接手的 AI 编码助手或开发者提供项目的系统架构、核心逻辑、通信接口及开发规约,以便于快速理解项目并进行无缝维护与扩展。


1. 项目定位与架构概述

Fluxor 是一个轻量级、无冗余的 Mihomo 内核管理面板与订阅生成系统。它采用前后端不分离的架构设计:

  • 后端 (Go):使用 Go 1.26 标准库(仅引入 gorilla/websocket 作为唯一外部依赖)。后端托管在 Unix Socket (/var/apps/Fluxor/target/app.sock) 上,对外通过前端反向代理暴露,内嵌了前端的所有静态资源。
  • 前端双版本并存与条件编译: 为了维护旧版的前端原生加载独立性,同时满足现代客户端的体验,项目支持双版本前端分流编译
    1. Vanilla JS 版(旧版,默认):无需任何构建步骤,直接嵌入 static/ 目录的静态原生 HTML/JS 源码。
    2. Vue 3 TypeScript 版(新版,主维护):源码位于 web/ 目录,由 Vue 3 (Composition API / Setup) + Vite + TailwindCSS + Pinia + TypeScript 构成。
    • 分流机制:后端利用 Go 条件编译标签进行控制:
      • assets_vanilla.go (go:build !vue):默认构建 Vanilla JS 前端。
      • assets_vue.go (go:build vue):使用 -tags vue 参数时,自动嵌入 web/dist 中的 Vue 3 前端。
    • 开发环境编译:任何新功能或漏洞修复请首选在 Vue 3 版本中维护,修改 Vue 代码后,需在 web 目录下执行 npm run build

核心功能职责

  1. 内核进程生命周期管理:负责本地 Mihomo 二进制文件的启动、停止、状态查询及配置热重载(不中断长连接)。
  2. 配置文件订阅与生成:读取用户的订阅链接及自定义规则集,生成内核可运行的 config.yaml
  3. 通信中转代理 (Bridge):由于 Mihomo 运行在本地 Unix Socket 上,Fluxor 后端作为前端与本地内核之间的“双向桥梁”,代理所有的 HTTP API 请求与 WebSocket 数据流(流量、内存、连接、日志等),并自动附加 Bearer Token 认证。

2. 目录结构与索引

fluxor/
├── main.go                 # 程序入口,路由注册,Unix Socket 监听,WebSocket 双向代理 (wsProxyHandler)
├── assets_vanilla.go       # 嵌入旧版静态资源 (go:build !vue)
├── assets_vue.go           # 嵌入 Vue 版编译产物 (go:build vue)
├── handlers_core.go        # 内核进程生命周期(start/stop/restart/coreRequest/cancelableReadCloser)
├── handlers_api.go         # 代理内核 HTTP API(流量、内存、连接、代理、规则、配置、DNS、GEO、升级等)
├── handlers_tproxy.go      # TProxy 防火墙与路由规则管理,例外 IP/端口过滤,本地出站代理控制
├── handlers_index.go       # 主页入口 index.html 模板渲染
├── handlers_utils.go       # JSON 错误响应工具 (writeJSONError/respondJSON) 及后端地址正则校验
├── subscribe.go            # 订阅配置 CRUD、config.yaml 生成、模板替换、MetaCubeXD config.js 修改
├── build/                  # 跨平台自动化编译与打包工具链(含 config_lite/base/full.yaml 模板)
├── static/                 # 旧版原生 Vanilla JS 前端目录
└── web/                    # 主维护 Vue 3 前端源码目录
    ├── package.json        # Vue 3.4 + Pinia + vue-i18n 9 + Vite 5 + Tailwind CSS 3 + TypeScript 5 + @vicons/ionicons5
    ├── vite.config.js      # 自定义 fluxorBuildPlugin:构建后将 index.html 移至 static/html/ 适配 embed.FS
    ├── tailwind.config.js  # data-theme 暗黑模式 + 扩展 accent/success/danger/warning 颜色
    ├── postcss.config.js   # Tailwind + Autoprefixer
    ├── index.html          # HTML 入口
    └── src/
        ├── main.ts         # 挂载 Pinia + vue-i18n (Composition API, legacy:false)
        ├── App.vue         # 根组件:响应式侧边栏/移动端底部 Tab、亮暗/跟随系统主题、中英切换、Toast 队列、Promise 确认框、统一轮询 coreStatus 状态
        ├── env.d.ts        # .vue 类型声明 & Window.BASE_URL 接口扩展
        ├── i18n.ts         # 全站国际化(zh/en),从 localStorage 读取语言偏好,禁止硬编码中文
        ├── index.css       # Tailwind 基础指令 + CSS 变量亮暗主题(data-theme 选择器)+ 自定义滚动条
        ├── components/     # 公共及细粒度组件 (ProxyGroupCard, FormSwitch)
        ├── composables/    # 全局解耦组合式函数 (useTheme, useLanguage)
        ├── utils/
        │   ├── api.ts      # withBase() 拼接 BASE_URL、apiFetch() HTTP 封装、wsConnect() WebSocket 封装(自动 ws/wss 协议选择)
        │   └── mock.ts     # 前端离线开发模拟器:拦截 HTTP/WS 请求提供 mock 数据,支持脱离后端独立测试
        ├── store/
        │   ├── global.ts   # 标签页激活状态、侧边栏折叠、亮暗/跟随系统主题、Toast 队列(3s 自动消失)、Promise 驱动确认框
        │   ├── config.ts   # 内核常规配置参数(allow-lan/ipv6/mode/log-level/tun/端口等,通过 app.vue 统一轮询 coreStatus,与订阅解耦)
        │   ├── subscription.ts # 订阅管理 Pinia Store:负责订阅配置 CRUD、解析及状态更新,由 config.ts 中拆分解耦而来
        │   ├── overview.ts # 仪表盘实时统计(速度/流量/内存/连接数/版本/当前节点)、60 点流量历史、3 路 WS + 1 路 HTTP 轮询
        │   ├── proxies.ts  # 代理组列表、节点延迟字典、手风琴展开状态、并发受限(10)批量测速
        │   ├── connections.ts # 活跃/已关闭连接列表、汇总统计、排序/搜索、WS 瞬时速率计算(快照差分)
        │   ├── rules.ts    # 规则列表、规则提供商列表、fetch/refresh 方法
        │   └── logs.ts     # 日志缓冲区(上限 2000 条)、自动滚动、暂停/继续、指数退避重连(1s~30s)
        └── views/
            ├── Overview.vue     # 概览:4 指标卡(上传/下载速度+总量)+ 4 信息卡(内存/连接数/版本/外部面板)+ Canvas 自绘折线图(max 60 点)
            ├── Proxies.vue      # 代理:手风琴展开/折叠、点击切换选择、单节点/组/全部测速、延迟着色(绿≤150 / 黄≤300 / 红>300ms/超时)
            ├── Rules.vue        # 规则:搜索过滤、启用/禁用开关(乐观更新+回滚)、规则提供商单个/全部更新
            ├── Connections.vue  # 连接:活跃/已关闭双标签、多列排序、搜索过滤、单条/全部断开(乐观更新移入 closed)、清空已关闭
            ├── Logs.vue         # 日志:暗色终端风格、级别过滤(Debug/Info/Warning/Error)、搜索、暂停/继续、智能自动滚动
            ├── Config.vue       # 配置:内核状态卡(启动/停止/升级)、常规参数、端口校验(1025-65535+重复检测)、TUN(gVisor/System/Mixed)、高级运维(重载/清缓存/GEO)、内置 DNS 查询
            └── Subscription.vue # 订阅:代理/面板端口、密钥显隐切换、规则集(lite/base/full)、UI 面板选择、订阅 CRUD 模态框(zoomIn 动画,支持订阅名称、链接、检测间隔、节点前缀)、流量/健康度/有效期卡片、「保存并应用」

Read the full file on GitHub · 233 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 8d ago First seen · 233 lines · 5,562 tokens per session scan A 99124bb58c9d

Subscribe to this mod's changes

fluxor AGENTS.md is an instructions file published in the GitHub repository shuangji66/fluxor (27 stars, last pushed 1mo ago), licensed Apache-2.0. It adds 5,562 tokens to every session, about $0.0278 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens