The Backend Helper - Your CLI Context help for AI and Humans
Project description
๐ ๏ธ Backend Helper (bck-nd-hlpr)
The Backend Helper: CLI Context & MCP Tooling for AI and Humans
bck-nd-hlpr is a lightweight Python CLI utility designed to bridge the gap between back-end codebases, human developers, and AI agents. It acts as a context provider, helping extract structural architecture, generate visual diagrams (such as Mermaid.js charts), and facilitate Model Context Protocol (MCP) interactions.
โก Quick Start
pip install bck-nd-hlpr
# Scan architecture and generate diagrams
bck-nd scan .
# Export LLM-ready context (tree + UML + ER + core files)
bck-nd prompt .
# Connect to Claude Desktop / Cursor (see ADVANCED.md)
bck-nd-mcp
๐งญ When to Use What
| Entry point | Best for |
|---|---|
bck-nd scan |
Interactive terminal analysis, diagrams, audits, and reports |
bck-nd prompt |
One-shot AI context file to paste into ChatGPT / Claude |
bck-nd-mcp |
Persistent MCP tools inside Claude Desktop or Cursor |
bck-nd explore |
Full-screen TUI to browse and visualize the codebase |
bck-nd docs / init-ci |
Static HTML portal and GitHub Pages automation |
| VS Code Extension | In-editor diagrams, audits, and clipboard context โ see README-EXTENSION.md |
โก Key Features
Detection & Architecture
- ๐ Auto-Detection: Flask, FastAPI, Django, Next.js, Express.js, NestJS, Gin, Actix-web, and more
- ๐ญ Architecture Recognition: MVC, Microservices, Layered Architecture patterns
- ๐ Polyglot Ready: C#, Python, JS/TS, Java, PHP, Go, Rust, Docker, Terraform, Prisma, SQL migrations
- โ๏ธ Flexible Config: Customize detection via
pyproject.toml - ๐ Automatic
.gitignoreSupport: Excludes ignored files from scans and context dumps - ๐ฑ Expo/React Native Detection: Appropriate diagramming for mobile projects
Diagrams & Visualization
- Smart Diagrams: Controllers, Models, Services, Routes โ Unicode or Mermaid output
- ๐จ Visual & Mermaid: Terminal diagrams or copy-paste Mermaid code
- ๐ Auto-Documentation (CI/CD): One-command GitHub Actions setup for living docs (
init-ci) - ๐ Jupyter Notebook Lineage (
--datascience): Data pipeline flowcharts from.ipynbfiles
AI & Context
- ๐ง AI Context Dump (
bck-nd prompt): Single LLM-optimized.txtwith project tree + UML + ER + core files - ๐ฏ Focused Export (
--uml,--er,--tree): Lightweight context files with only the sections you need - ๐ค BYO-Key AI Analysis: OpenAI, Anthropic, Gemini, OpenRouter, or local Ollama โ no middleware
- โ๏ธ
--max-core-files N: Limit core files exported bybck-nd prompt
Quality, Security & Onboarding
- ๐ก๏ธ Dependency-Free Core: No PyTorch, No Transformers. Installs in <3 seconds
- ๐ช OS-Safe Scanning: Ignores
venv,node_modules, and restricted system paths - ๐ Guided Onboarding (
--teach): Tier-ordered learning curriculum via dependency heatmaps - ๐ก๏ธ QA Impact Radius (
--impact-radius <file>): Transitive reverse-dependency blast radius - ๐ API Contract Map (
--contract): Match API endpoints to ORM tables and columns - โค๏ธ Project Health Score (
--health): 0โ100 score with letter grade (AโF)
๐ Version 2.0.0
Major architecture release: decoupled core/ engine, concurrent ScannerOrchestrator, thread-safe file cache, lazy parser loading, fault-tolerant scans, and direct .mmd export. Full details in CHANGELOG.md. Advanced usage (library API, MCP config, architecture diagram) in ADVANCED.md.
๐๏ธ ORM Parser Support Status
| ORM | Parser Type | Coverage / Status |
|---|---|---|
| SQLAlchemy (Python) | Tree-Sitter | Full AST Extractor |
| Django ORM (Python) | Tree-Sitter | Full AST Extractor |
| Entity Framework Core (C#) | Tree-Sitter | Full AST Extractor |
| Prisma (Schema) | Regex / Lexer | Schema Matcher |
| TypeORM (JS/TS) | Regex / Lexer | Structural Matcher |
| Sequelize (JS/TS) | Regex / Lexer | Structural Matcher |
๐ฆ Installation
# From source
cd bck-nd-hlpr
pip install .
# Development mode
pip install -e .
# Verify
bck-nd --help
# Optional: Set your preferred AI Provider key
# set OPENAI_API_KEY=sk-... (Windows)
# export OPENAI_API_KEY=sk-... (Mac/Linux)
๐ docs - Static HTML Portal Generation
Automatically generates a complete, static HTML documentation portal for your project. Perfect for CI/CD and GitHub Pages.
Usage
# Generate docs in the current directory (output folder: 'docs')
bck-nd docs . --output docs
What you get in docs/index.html:
- Infrastructure Map: Visual representation of
docker-compose.yml. - API Routes: Sequence diagrams of HTTP endpoints.
- UML Class Diagram: Auto-generated class hierarchy with associations and dependencies.
- Entity-Relationship: E-R diagrams for ORM models (Entity Framework, SQLAlchemy, Django).
- Technical Debt: Actionable table of TODOs and FIXMEs.
- Fully self-contained, using MermaidJS CDN for rendering. No heavy build tools required.
๐ง prompt - AI Context Dump
Generates a single, LLM-optimized .txt file with XML-like tags that you can copy-paste directly into ChatGPT, Claude, or any AI to give it instant, complete understanding of your project.
No more manually explaining your codebase structure โ one command, one file, instant AI context.
Full Mode (Default)
# Generate ai_context.txt in the current directory
bck-nd prompt .
# Custom output file
bck-nd prompt /my/project -o context.txt
# Deeper scan (default depth is 4)
bck-nd prompt . --depth 6
Focused Mode (--uml, --er, --tree)
Export only the sections you need into a lightweight file. The default output filename adapts dynamically:
| Flags used | Default output file |
|---|---|
--uml |
ai_context_uml.txt |
--er |
ai_context_er.txt |
--tree |
ai_context_tree.txt |
--uml --er |
ai_context_diagrams.txt |
--uml --er --tree |
ai_context_diagrams.txt |
| (no flags) | ai_context.txt |
# UML diagram only
bck-nd prompt . --uml
# ER diagram only
bck-nd prompt . --er
# Project tree only
bck-nd prompt . --tree
# Combine: UML + ER diagrams
bck-nd prompt . --uml --er
# Custom output with focused flag
bck-nd prompt . --uml -o my_diagrams.txt
What the full file contains
| XML Tag | Contents |
|---|---|
<project_tree> |
Clean ASCII directory tree (no venv/node_modules) |
<architecture_uml> |
UML Class Diagram in Mermaid format |
<architecture_er> |
Entity-Relationship Diagram in Mermaid format |
<core_files> |
Content of the 3-5 most important backend files |
How to use it
- Run
bck-nd prompt .in your project root - Open
ai_context.txt - Select All โ Copy
- Paste into ChatGPT / Claude as the first message
- Start asking questions about your codebase immediately!
Example output structure
<!-- bck-nd-hlpr Context Dump -->
<!-- Paste this file into ChatGPT / Claude for instant AI context -->
<project_tree>
my-project/
+-- src/
| +-- main.py
| +-- models.py
\-- tests/
</project_tree>
<architecture_uml>
```mermaid
classDiagram
class User { ... }
```
</architecture_uml>
<architecture_er>
```mermaid
erDiagram
User { int id PK }
```
</architecture_er>
<core_files>
<file path="src/main.py">
```python
# ... file content ...
```
</file>
</core_files>
๐ init-ci - GitHub Actions Automation
Set up "Living Documentation" in seconds. This command injects a ready-to-use GitHub Action into your repository.
Usage
bck-nd init-ci
What it does:
- Creates
.github/workflows/bck-nd-docs.yml. - Configures an automatic trigger on
pushto themainbranch. - Installs
bck-nd-hlprin the CI runner. - Generates the full HTML portal (UML, ER, Infra, Routes).
- Deploys the result automatically to GitHub Pages.
๐ต๏ธ scan - Automatic Architecture Detection
Automatically scans your project, detects the framework and architecture, and generates intelligent diagrams.
Basic Usage
# Scan current directory (default depth: 3)
bck-nd scan .
# Scan specific directory
bck-nd scan src
# Custom depth
bck-nd scan . --depth 5
Modes
1. Full Architecture Overview (Default)
bck-nd scan .
Output:
- Framework detection (Flask, FastAPI, Django, etc.)
- Architecture type (MVC, Microservices, etc.)
- Features (Docker, Auth, Database, etc.)
- Infra Map: Docker Compose services
- API Routes: Endpoints sequence diagram
- UML & ER: Class and Entity-Relationship Mermaid diagrams
- TODOs: Technical Debt Report
2. Mermaid Export
bck-nd scan . --format mermaid
Output:
- Generates
graph TDcode ready to copy-paste into Notion, GitHub, or Obsidian. - Also shows the specific visual diagram in the terminal for instant preview.
- Perfect for documentation and presentations.
3. UML Class Diagram
bck-nd scan . --uml
- Generates
classDiagramcode for Mermaid.js. - Uses a unified multi-language parser combining AST (Python) and Tree-Sitter (C#, Java, JS/TS, PHP) to extract classes, methods, properties, and constructors automatically.
- Automatically infers relationships (
-->Associations,..>Dependencies) and inheritance (<|--) across all files.
4. Diagram + Local Report
bck-nd scan . --explain
Output:
- Everything from mode 1, PLUS
- Text-based component breakdown
- List of Controllers, Models, Services
- No AI required (100% offline)
5. Entity-Relationship Diagram (ER)
bck-nd scan . --er
Output:
- Generates
erDiagramfor Mermaid.js. - Scans modern schema configurations, migrations, and ORMs across languages:
- Modern Configs: Prisma Schemas (
schema.prisma), Drizzle ORM schemas (.ts/.js), and raw SQL migrations (.sql) - Traditional ORMs: Entity Framework (C#), Spring Boot / JPA (Java), Laravel / Eloquent (PHP), SQLAlchemy / Django models (Python), and Sequelize / Mongoose (JS/TS)
- Modern Configs: Prisma Schemas (
- Bulletproof Mermaid Syntax: Safely handles Generics (e.g.
List<T>), table brackets, and special characters. - Detects database columns, primary keys (
PK), data annotations, and auto-generates bidirectional relationships (||--o{,}o--||) with intelligent schema deduplication and merging.
6. API Route Map
bck-nd scan . --routes
Output:
- Generates
sequenceDiagramfor Mermaid.js. - Scans
FlaskandFastAPIendpoints. - Visualizes
Client -> APIinteractions with methods and paths.
7. Infrastructure Diagram
bck-nd scan . --infra
Output:
- Generates
graph LRfor Mermaid.js. - Scans
docker-compose.ymlfiles. - Shows services, images, and dependencies.
- Database services (postgres, redis, mysql, mongo) displayed as cylinders.
8. Technical Debt Scanner
bck-nd scan . --todo
Output:
- Scans for TODO, FIXME, HACK, XXX, BUG comments
- Beautiful color-coded table using Rich
- Shows file, line number, type, and message
- Statistics by debt type
- Debt level assessment
- Perfect for code reviews and sprint planning
9. Security Audit
bck-nd scan . --audit
Output:
- Scans for hardcoded secrets, keys, and dangerous config
- Reports "Critical" risks like AWS Keys or Private PEMs
- Reports "High/Warning" risks like DB passwords or hardcoded IPs
- Essential for pre-commit checks
10. Dependency Heatmap
bck-nd scan . --impact
Output:
- Shows a "Heatmap" of your files based on how many other files import them.
- Helps identify "Core" modules that are risky to refactor.
- Sorts by Impact Score and assigns Risk Categories (
๐ฅ CORE,๐ก SHARED,๐ข PERIPHERAL).
11. Route-to-DB Traceability
bck-nd scan . --trace
Output:
- Generates
graph LRfor Mermaid.js. - Traces API calls starting from your routes down to your services and models.
- Parses AST (currently supports Python: FastAPI/Flask).
12. Guided Onboarding
bck-nd scan . --teach
Output:
- Evaluates file relationships to calculate reading hierarchy.
- Outputs a color-coded sequential table dividing the codebase into Entrypoints, Core Logic, and Infra/Database files.
13. Data Science Lineage Map
bck-nd scan . --datascience
Output:
- Parses
.ipynbJSON nodes and analyzes cells. - Generates a Mermaid
graph LRlineage flowchart mapping input files, notebooks, and outputs/models.
14. QA Impact Radius
bck-nd scan . --impact-radius src/bck_nd_hlpr/route_parser.py
Output:
- Traverses reverse-dependencies transitively using BFS.
- Outputs a clean report showing the complete affected file chain and a list of impacted API endpoints.
15. API Contract Map
bck-nd scan . --contract
Output:
- Matches backend API routes with ORM models using path-matching, handler-naming, and import-based heuristics.
- Renders a structured terminal table displaying endpoints, matched database tables, and their column schemas.
16. Project Health Score
bck-nd scan . --health
Output:
- Calculates a consolidated 0-100 quality score.
- Renders a beautifully styled Rich report card featuring letter grades (A-F) and details of security/debt point deductions.
17. Diagram + AI Analysis
bck-nd scan . --ai
Output:
- Everything from mode 1, PLUS
- AI-powered architectural analysis
- Design pattern recommendations
- Code quality insights
- Detects API keys in your environment (OpenAI, Anthropic, Gemini, OpenRouter) or uses a local Ollama server.
18. Force Specific AI Provider
bck-nd scan . --ai --provider openai
Output:
- Supported providers:
openai,anthropic,gemini,groq,deepseek,openrouter,ollama. - Safely reports a styled error if the corresponding API key is missing.
19. AI Only (No Diagram)
bck-nd scan . --no-graph --ai
Output:
- Only AI analysis (no Mermaid diagram)
- Faster for text-only reports
20. Project File/Directory Tree
bck-nd scan . --tree
Output:
- Generates a clean ASCII directory tree of the project using Unicode box-drawing characters.
- Automatically and silently filters out ignored directories (such as
node_modules,venv,.git, etc.) based onGLOBAL_IGNORE_DIRS.
Use
--ai --style <name>to change AI tone. See AI Personalities (Fun Styles) at the end of this document.
๐ flow - Manual Diagram Generation
Create custom architecture diagrams from string descriptions.
Usage
bck-nd flow "Client -> API -> Database"
bck-nd flow "Client -> LoadBalancer -> [API_v1, API_v2] ; API_v1 -> Redis"
bck-nd flow "User -> Auth [Service] -> JWT [Token] -> API"
Syntax
A -> B- Creates connection from A to B[X, Y, Z]- Multiple nodes in same position;- New row[DB],[SQL],[DATA]- Rendered as database cylinders[Service],[DIR]- Rendered as soft boxes[?],[IF]- Rendered as diamonds
๐ Command Manual
๐ฅ๏ธ explore - Interactive TUI Mode (Explorer)
Launch a full-screen Terminal User Interface (TUI) to interactively explore your project's architecture, powered by textual.
Usage
bck-nd explore
What you get:
- Sidebar: Directory tree to navigate your codebase.
- Main View: Click on a
.pyfile to instantly generate its ASCII diagram and Mermaid Sequence routes. - Dynamic Analysis: Click on a folder to see the high-level architecture of that specific directory.
- Shortcuts: Press
Dto toggle dark/light mode,Qto quit.
๐ฏ Usage Examples
Example 1: Quick Project Analysis
cd my-backend-project
bck-nd scan .
What you get:
๐ Analyzing architecture of '.'...
๐ป Framework detected: FastAPI
๐ญ Architecture: REST API (Route-based)
โจ Features: Docker, SQLAlchemy ORM, Authentication
๐ FastAPI application using REST API (Route-based) with Docker, SQLAlchemy ORM, Authentication.
๐ ARCHITECTURE DIAGRAM:
[ASCII diagram showing Routes -> Services -> Models -> Database]
Example 2: Deep Analysis with AI
bck-nd scan . --ai --style pro --depth 5
What you get:
- Complete architecture detection
- Full project diagram
- AI analysis including:
- Design pattern recommendations
- Security considerations
- Performance optimization suggestions
- Code quality assessment
Example 3: Text-Only Report
bck-nd scan src --explain --no-graph
What you get:
- Framework/architecture detection
- Component list without diagram
- Perfect for CI/CD logs
Example 4: Compare Two Approaches
# Old monolith
bck-nd scan ./legacy --ai --style ramsay
# New microservices
bck-nd scan ./new-arch --ai --style pro
๐ง Architecture Detection
Backend Helper automatically detects:
Frameworks
| Language | Frameworks |
|---|---|
| Python | Flask, FastAPI, Django (Specialized ER/UML), Quart |
| JavaScript/TypeScript | Next.js (Filesystem Routes & React UML), Express.js (Specialized ER/UML), Fastify, Koa, NestJS (Route Detection) |
| Java | Spring Boot (Specialized ER/UML), Maven, Gradle |
| PHP | Laravel (Specialized ER/UML) |
| C# / .NET | .NET Core, Entity Framework (Specialized ER/UML) |
| Go | Gin, Fiber |
| Rust | Actix-web, Rocket |
Architecture Patterns
- Microservices Architecture - Multiple services in docker-compose
- MVC + Services (Layered) - Controllers, Models, Services folders
- MVC Pattern - Controllers + Models
- REST API (Route-based) - Routes + Models
- Containerized Application - Docker detected
- Monolithic Application - Fallback
Features Detection
- Docker / Docker Compose
- Databases (SQL, SQLite)
- ORM (SQLAlchemy, Django ORM)
- Authentication (JWT, OAuth)
- API Documentation (Swagger/OpenAPI)
- CI/CD (GitHub Actions, GitLab CI)
- Unit Tests
- Security: Auto-redaction of secrets in output (Sanitizer)
Configuration
See ADVANCED.md for pyproject.toml overrides and library usage.
๐พ Output Persistence
Save any report or diagram with -o / --output. ANSI color codes are stripped automatically. See ADVANCED.md for .mmd export details.
# Save ASCII diagram
bck-nd scan . -o architecture.txt
# Save Technical Debt Report (Clean text)
bck-nd scan . --todo -o report.txt
# Save Mermaid diagram directly to a .mmd file (ANSI codes stripped automatically)
bck-nd scan . --er -o db.mmd
๐งช AI Providers Setup (BYO-Key)
Backend Helper automatically loads .env files if they exist in your project root.
โ ๏ธ Security Warning: Never commit
.envto public repositories;init-cidoes not inject keys into the repo.
Preferred order (checked automatically):
# Preferred order (checked automatically)
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...
GOOGLE_API_KEY=AIzaSy...
OPENROUTER_API_KEY=sk-or-... # 200+ models, free tier โ https://openrouter.ai/keys
OLLAMA_HOST=http://localhost:11434 # Local Ollama, no key required
Then run:
bck-nd scan . --ai
Option 3: Ollama (Local AI)
No API key required. Make sure Ollama is running on http://localhost:11434.
# Optionally customize the host
export OLLAMA_HOST="http://localhost:11434"
bck-nd scan . --ai --provider ollama
๐ค MCP Integration (Claude Desktop / Cursor)
Backend Helper includes an MCP server with 20 local architecture tools for Claude Desktop and Cursor.
bck-nd-mcp
For the full tool list, client configuration, and troubleshooting, see ADVANCED.md.
Comparison: Different Commands
| Command | Architecture Detection | Diagram | Text Report | AI Analysis | AI Context File |
|---|---|---|---|---|---|
bck-nd scan . |
โ | โ (Full Arch) | โ | โ | โ |
bck-nd scan . --explain |
โ | โ | โ | โ | โ |
bck-nd scan . --teach |
โ | โ | โ (Onboarding) | โ | โ |
bck-nd scan . --datascience |
โ | โ (Data Line) | โ | โ | โ |
bck-nd scan . --ai |
โ | โ | โ | โ | โ |
bck-nd scan . --explain --ai |
โ | โ | โ | โ | โ |
bck-nd scan . --no-graph --ai |
โ | โ | โ | โ | โ |
bck-nd scan . --uml |
โ | โ (UML Class) | โ | โ | โ |
bck-nd scan . --er |
โ | โ (ER DB) | โ | โ | โ |
bck-nd scan . --routes |
โ | โ (API Seq) | โ | โ | โ |
bck-nd scan . --infra |
โ | โ (Docker LR) | โ | โ | โ |
bck-nd scan . --todo |
โ | โ | โ (Debt) | โ | โ |
bck-nd scan . --audit |
โ | โ | โ (Sec. Risks) | โ | โ |
bck-nd scan . --impact |
โ | โ | โ (Impact Heatmap) | โ | โ |
bck-nd scan . --impact-radius |
โ | โ | โ (Impact Chain) | โ | โ |
bck-nd scan . --contract |
โ | โ (Contract) | โ | โ | โ |
bck-nd scan . --health |
โ | โ | โ (Health Grade) | โ | โ |
bck-nd scan . --trace |
โ | โ (Trace LR) | โ | โ | โ |
bck-nd scan . --tree |
โ | โ (File Tree) | โ | โ | โ |
bck-nd prompt . |
โ | โ (Mermaid) | โ | โ | โ (XML) |
bck-nd flow "A -> B" |
โ | โ | โ | โ | โ |
bck-nd explore |
โ | โ | โ | โ | โ |
bck-nd docs . |
โ | โ (All HTML) | โ (HTML Portal) | โ | โ |
bck-nd chat . |
โ | โ (Loaded) | โ | โ (Interactive) | โ |
bck-nd init-ci |
โ | โ | โ | โ | โ |
๐ Troubleshooting
"No files found"
Solution:
# Increase depth
bck-nd scan . --depth 5
# Or scan specific directory
bck-nd scan src --depth 3
"Connection error: ..."
Cause: The selected AI provider is unreachable or the API key is invalid. Solution: Verify your API key is set correctly, or switch to a different provider:
# Try OpenRouter (free tier available)
export OPENROUTER_API_KEY=sk-or-...
bck-nd scan . --ai
# Or use local Ollama (no key required)
bck-nd scan . --ai --provider ollama
"Framework detected: Unknown"
Cause: Framework not yet supported or non-standard structure
Solution: Use bck-nd flow for manual diagrams
โ ๏ธ Known Limitations
bck-nd-hlpr uses static heuristics and parsers โ not a full language server or compiler. Keep these in mind:
| Area | Coverage | Notes |
|---|---|---|
| UML (Tree-Sitter) | C#, Java, JS/TS, PHP, Python | Best-effort AST extraction; dynamic metaprogramming may be missed |
| UML (Regex/Lexer) | TypeORM, Sequelize | Structural matching only โ no full type inference |
| ER (Tree-Sitter) | SQLAlchemy, Django, EF Core | Full AST where supported |
| ER (Regex/Lexer) | Prisma, TypeORM, Sequelize | Schema-level matching; complex generics may be simplified |
| Route parsing | Flask, FastAPI (primary) | Other frameworks: detection only, limited endpoint extraction |
| Traceability | Python (FastAPI/Flask) | Route-to-DB tracing not yet polyglot |
| API Contract Map | Heuristic | Matches routes to models by naming/import patterns โ not runtime validation |
| Security audit | Pattern-based | Catches common secret patterns; not a substitute for dedicated SAST tools |
Parser errors on individual files are collected in execution_warnings and do not abort the scan. See CHANGELOG.md.
๐ญ AI Personalities (Fun Styles)
Note: AI personalities work with all supported direct providers (OpenAI, Anthropic, Gemini, OpenRouter, Ollama). For production documentation, use
proorhacker.
| Style | Description | Use Case |
|---|---|---|
pro |
Senior Software Architect - Technical, formal | Production documentation |
hacker |
Security Expert - Focuses on vulnerabilities | Security audits |
soviet |
Soviet Engineer - Efficiency-focused | Performance reviews |
eli5 |
Kindergarten Teacher - Simple explanations | Onboarding juniors |
ramsay |
Gordon Ramsay - Brutally critical | Code reviews |
jarvis |
Tony Stark's AI - Elegant, helpful | Executive presentations |
corporate |
Manager - Buzzword-heavy | Stakeholder reports |
medieval |
Ancient Wizard - Metaphorical | Creative documentation |
doom |
Doom Slayer - Bugs are demons | Bug hunting |
bck-nd scan . --ai --style pro # Professional
bck-nd scan . --ai --style hacker # Security-focused
bck-nd scan . --ai --style ramsay # Critical review
๐ Supported File Types
| Type | Detection Method | Output Shape |
|---|---|---|
| Controllers | *controller.py, *ctrl.py |
Box โ API |
| Models | *model.py, *entity.py, *schema.py |
Box โ Database (Cylinder) |
| Services | *service.py, *svc.py |
Box โ Business Logic |
| Routes | *route.py, *router.py |
Box โ Endpoints |
| Middleware | *middleware.py |
Box โ Request Pipeline |
| Database Files | .sql, .db, .sqlite |
Cylinder โ Data Storage |
| Docker | Dockerfile, docker-compose.yml |
Soft Box |
| ORM | SQLAlchemy, Django, Prisma, etc. | Cylinder โ DB Access |
| Infrastructure | .tf (Terraform) |
Box โ Infrastructure |
๐งฌ How it Started
bck-nd-hlpr evolved from an earlier experiment (ASCII Architect, a hooby proyect where I teach how to write ASCII basic forms to a GPT-2 model). It worked, but required ~2GB of dependencies just to draw a diamond. This project rebuilds the same idea from scratch: deterministic renderers, no model downloads, installs in under 3 seconds.
๐ Real-World Usage
CI/CD Integration
Option A: Automatic Setup (Recommended)
# Run this once locally to inject the workflow
bck-nd init-ci
git add . && git commit -m "ci: add auto-documentation" && git push origin main
Option B: Manual YAML
# .github/workflows/arch-analysis.yml
- name: Analyze Architecture
run: |
pip install bck-nd-hlpr
bck-nd scan . --explain --no-graph > architecture.txt
Code Review Automation
# Before PR approval
bck-nd scan . --ai --style pro > review.md
Documentation Generation
# Generate architecture docs
bck-nd scan . --explain > docs/ARCHITECTURE.md
bck-nd scan . --ai --style pro > docs/AI_ANALYSIS.md
๐ Documentation
- CHANGELOG.md - Release history
- ADVANCED.md - MCP setup, library API, architecture diagram
- vscode-extension/README-EXTENSION.md - VS Code extension guide
- IA-context.md - Development rules & architecture
- ROADMAP.txt - Feature roadmap
๐ก Philosophy
"Less guessing, more coding."
Backend Helper is designed for speed, intelligence, and actionable insights. No bloated dependencies, no waiting for model downloads. Just instant architectural understanding.
๐ค Contributing
Issues and PRs welcome! See IA-context.md for development guidelines.
๐ License
MIT License - See LICENSE file for details
Built with โค๏ธ for developers who value clarity and speed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bck_nd_hlpr-2.0.3.tar.gz.
File metadata
- Download URL: bck_nd_hlpr-2.0.3.tar.gz
- Upload date:
- Size: 147.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6e7f211e986426c7d5e0e37a587fdab9e195262baa27107d47643917e9d5f1c7
|
|
| MD5 |
2f2b804c4a172c494d3d9153c0a0c4b5
|
|
| BLAKE2b-256 |
a027cc49c3477bb12b9a257b016d6026eef48ebe9f3d6deb24c27b891362e7d6
|
File details
Details for the file bck_nd_hlpr-2.0.3-py3-none-any.whl.
File metadata
- Download URL: bck_nd_hlpr-2.0.3-py3-none-any.whl
- Upload date:
- Size: 143.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f6a43d70343c7c2566d2dded267e7f82e5fb107fa41fdbdc6959baee5881418c
|
|
| MD5 |
e40b267e8481ab2194be6239fb7a6c8a
|
|
| BLAKE2b-256 |
18e4a0f0c05a43377b1dfcbea77d6338cf0c14a3c5d63de297b1d067a4691eed
|