What is docuflow-studio AGENTS.md?

A repository guide for DocuFlow Studio, an open-source system for managing IT assets and creating handover documents. It describes the project structure, technologies, and checks for Python and TypeScript code.

Use it when navigating DocuFlow Studio, locating important files, installing or running its backend and frontend, or verifying changes before delivery.

It gives developers and coding agents the context needed to work in an unfamiliar repository. It also records the commands used to check syntax and create a production frontend build.

How ghuyphan/docuflow-studio configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to ghuyphan/docuflow-studio. 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/ghuyphan/docuflow-studio/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/ghuyphan/docuflow-studio

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/ghuyphan/docuflow-studio/agents-md/github.svg)](https://agentmods.dev/instructions/ghuyphan/docuflow-studio/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/ghuyphan/docuflow-studio/agents-md"><img src="https://agentmods.dev/badge/instructions/ghuyphan/docuflow-studio/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/ghuyphan/docuflow-studio/agents-md"><img src="https://agentmods.dev/badge/instructions/ghuyphan/docuflow-studio/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,494 This file is loaded in full into every session.

When invoked 1,494 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.

Model	Per session	Once invoked
Fable 5.1	$0.01494	$0.01494
Opus 5.5	$0.00598	$0.00598
Sonnet 5.5	$0.00299	$0.00299
Haiku 4.5	$0.00149	$0.00149

Measured 2mo ago against content hash 5c8dad9553db, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

docuflow-studio 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 2mo 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 · 116 lines

How it starts

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

🤖 AGENTS.md - Developer & AI Agent Guide for DocuFlow Studio

Welcome AI Agents & Developer Assistants! This document provides architectural context, project structure sitemaps, development commands, design system conventions, and guidelines for working on DocuFlow Studio.

🎯 Repository Overview

DocuFlow Studio is an open-source, full-stack IT Asset Management & Automated Handover Document system.

Backend: FastAPI (Python 3.10+), SQLAlchemy (SQLite), Pydantic v2, python-docx, openpyxl, PyJWT.
Frontend: React 18 (TypeScript), Vite, Tailwind-compatible Glassmorphism UI (index.css), Lucide React icons, html5-qrcode.
Desktop Application: Tkinter GUI (app.py), System Tray App (tray_app.py via Pystray & Uvicorn background server).
Deployment: Docker & Docker Compose (Dockerfile, docker-compose.yml).

📁 Repository Sitemap & Key Files

docuflow-studio/
├── app.py                      # Desktop GUI application (Tkinter launcher)
├── tray_app.py                 # System Tray app with background FastAPI server
├── requirements.txt            # Python dependencies
├── Dockerfile & docker-compose # Container deployment definitions
├── .env & .env.example         # Environment variables & branding configs
├── README.md                   # User documentation
├── CUSTOMIZATION.md            # Styling, template & label customization guide
├── LICENSE                     # MIT License
├── backend/
│   ├── main.py                 # FastAPI application entrypoint & middleware
│   ├── database.py             # SQLAlchemy engine & session maker
│   ├── models.py               # ORM Database Models (User, Device, DocumentHistory, AuditLog)
│   ├── schemas.py              # Pydantic request/response validation schemas
│   ├── crud.py                 # Core database operations, search filters, Excel imports
│   ├── doc_generator.py        # Word (.docx) handover document builder engine
│   ├── auth.py                 # Password hashing & JWT token generation
│   ├── routers/                # REST API Endpoint Routers
│   │   ├── auth.py             # /api/auth (Login, Seed, Reset Password)
│   │   ├── devices.py          # /api/devices (CRUD, Search, Bulk Actions, QR lookup)
│   │   ├── documents.py        # /api/documents (Generate, Download, Handover, Recovery)
│   │   ├── audit_logs.py       # /api/audit-logs (Activity Logging)
│   │   └── templates.py        # /api/templates (Manage Word templates)
│   └── services/               # Background & parsing services
│       ├── parser.py           # Multi-sheet Excel inventory parser & column detection
│       ├── scheduler.py        # Background task scheduler & backup routines
│       └── network.py          # CIFS/SMB network share backup integration
├── frontend/
│   ├── package.json            # Node.js dependencies & Vite scripts
│   ├── vite.config.ts          # Vite build config & dev proxy setup
│   ├── src/
│   │   ├── main.tsx            # React application root
│   │   ├── App.tsx             # Main routing, layout, and view switcher
│   │   ├── index.css           # Global design system, glassmorphism tokens, CSS variables
│   │   ├── components/         # Reusable UI components
│   │   │   ├── PrintLabelModal.tsx   # QR code thermal label printer modal
│   │   │   ├── QrScannerModal.tsx    # Live camera & manual QR scanner modal
│   │   │   ├── ScanActionHub.tsx     # Bulk scanning & inventory audit hub
│   │   │   ├── DeviceSelectModal.tsx # Multi-device selector for document generation
│   │   │   ├── CustomDropdown.tsx    # Accessible dropdown component
│   │   │   ├── Pagination.tsx        # Data table pagination controls
│   │   │   └── StatusBadge.tsx       # Equipment status badges
│   │   └── views/              # Main Application Pages
│   │       ├── DashboardView.tsx     # Metrics, status counts & quick actions
│   │       ├── DevicesView.tsx       # Device inventory table & management
│   │       ├── DocumentFlowView.tsx  # Handover / Recovery document wizard
│   │       ├── HistoryView.tsx       # Handover history & file download log
│   │       ├── AuditLogsView.tsx     # System audit trail
│   │       ├── UserManagementView.tsx# User accounts & RBAC management
│   │       ├── TemplatesView.tsx     # Word template manager
│   │       └── LoginView.tsx         # Modern glassmorphism authentication page
└── templates/                  # Word document templates (.docx)
    ├── template_bbbg.docx      # Standard handover form template
    └── template_recovery.docx  # Equipment recovery form template

Read the full file on GitHub · 116 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.

2mo ago First seen · 116 lines · 1,494 tokens per session scan A 5c8dad9553db

Subscribe to this mod's changes

docuflow-studio AGENTS.md is an instructions file published in the GitHub repository ghuyphan/docuflow-studio (6 stars, last pushed 3mo ago), licensed MIT. It adds 1,494 tokens to every session, about $0.0060 per session on Opus 5.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-31.

docuflow-studio AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
docuflow-studio AGENTS.mdghuyphan/docuflow-studio	Instructions file	6	3mo ago	MIT	A	1,494	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,649	GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
vscode ai-customization.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	1,907	GitHub Copilot

docuflow-studio: Instructions file for Codex