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.

In plain words
What is it for?
Use it when navigating DocuFlow Studio, locating important files, installing or running its backend and frontend, or verifying changes before delivery.
Why use it?
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.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/ghuyphan/docuflow-studio/agents-md
Clone the repo
git clone --depth 1 https://github.com/ghuyphan/docuflow-studio

Made for: Codex, OpenCode.

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. Scan, not verified.
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 $0.01494 $0.01494
Opus 5 $0.00747 $0.00747
Sonnet 5 $0.00299 $0.00299
Haiku 4.5 $0.00149 $0.00149

Measured 3d ago against content hash 5c8dad9553db, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 3d 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.

  1. 3d 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 1mo ago), licensed MIT. It adds 1,494 tokens to every session, about $0.0075 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-31.

Related

Other instructions, from other repositories

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

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

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,182 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,345 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

next.js 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