nexoralnexoral/AxioDB/electron/AGENTS.md

AxioDB / electron

AGENTS.md35 starsChanged 9 days agoMITView on GitHub

Global rules live in ../AGENTS.md. This file only adds electron/ specifics — read the root first. Role — the native desktop app "AxioDB Control" (appId: com.axiodb.control). Renderer is a React UI that connects to any AxioDB server; main process is TypeScript compiled to CJS. Packaged with electron-builder for Linux (.deb/.AppImage), Windows (NSIS .exe), macOS (.zip). Electron 34 · electron-builder 25 · Vite 6 + @vitejs/plugin-react-swc (renderer) · React 19 · Tailwind v4 · Zustand · Axios · Recharts · concurrently…

Installs packages

Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,843 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository12 other files it gives its agents.
- AGENTS.mdAGENTS.md
- cli/AGENTS.mdAGENTS.md
- Docker/AGENTS.mdAGENTS.md
- Document/AGENTS.mdAGENTS.md
- Email/AGENTS.mdAGENTS.md
- GUI/AGENTS.mdAGENTS.md
- Scripts/AGENTS.mdAGENTS.md
- source/AGENTS.mdAGENTS.md
- Test/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- skillSkill

The file

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Only dist/, dist-electron/, resources/, package.json ship (see electron-builder.json files).
line 42
Very specific:
Keep the renderer talking to the server through src/api + src/config/key.js.
line 43

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

AGENTS.md

electron/ — AxioDB Control Desktop App (Agent Instructions)

Global rules live in ../AGENTS.md. This file only adds electron/ specifics — read the root first.

Role — the native desktop app "AxioDB Control" (appId: com.axiodb.control). Renderer is a React UI that connects to any AxioDB server; main process is TypeScript compiled to CJS. Packaged with electron-builder for Linux (.deb/.AppImage), Windows (NSIS .exe), macOS (.zip).

Stack

Electron 34 · electron-builder 25 · Vite 6 + @vitejs/plugin-react-swc (renderer) · React 19 · Tailwind v4 · Zustand · Axios · Recharts · concurrently + wait-on for dev.

Layout

main/            main.cts (entry), preload.cts — compiled to dist-electron/main.cjs
src/             renderer (React) — api/ (client.js, authApi.js), components/, config/key.js,
                 layout/ (Sidebar.jsx, StatusBar.jsx, Titlebar.jsx), pages/, store/, utils/,
                 App.jsx, main.jsx, index.html
resources/       build resources + icons (icon.png, icons/) — bundled via extraResources
electron-builder.json   packaging config (targets, icons, nsis options)
vite.config.js   renderer build → dist/
dist/ · dist-electron/ · release/   generated, gitignored

Commands

cd electron
npm install
npm run dev            # vite + electron together (waits on tcp:5173)
npm run build:renderer # vite build → dist/
npm run build:main     # tsc -p tsconfig.json → dist-electron/
npm run pack           # electron-builder --dir (unpacked, for smoke testing)
npm run dist:linux     # deb + AppImage
npm run dist:win       # nsis
npm run dist:mac       # zip
npm run dist           # linux only; `npm run build` does all three + pack

Hard rules

Package main is dist-electron/main.cjs — the main-process TS (main.cts) compiles to CJS via tsconfig.json (module: NodeNext, rootDir: main, outDir: dist-electron). Don't change the extension or output path without updating package.json.
Only dist/**, dist-electron/**, resources/**, package.json ship (see electron-builder.json files). New runtime assets must be added there or reachable from resources/.
Keep the renderer talking to the server through src/api + src/config/key.js; no hardcoded hosts in components.
dist/, dist-electron/, release/, node_modules/, .vite/ are gitignored — never commit them.
Rendering/CI cross-compiles with Wine for Windows — don't assume a Windows host.

Version sync (this folder)

electron/package.json → "version"
src/layout/StatusBar.jsx → displayed AxioDB Control v<version>

Both are rewritten by Scripts/versionController.sh.

Done for this folder

npm run build:renderer + npm run build:main pass
npm run pack launches and connects to a running server
New assets registered in electron-builder.json files/extraResources
electron/package.json + StatusBar.jsx versions match root when releasing

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free