DevProjex

<h1 align="center">DevProjex 📁🌳</h1>

<h2 align="center">🏆 Officially Selected by the Avalonia UI Team for the <a href="https://avaloniaui.net/showcase">App Showcase</a></h2>

<p align="center">
  <a href="https://github.com/Avazbek22/DevProjex/releases"><img alt="Downloads" src="https://img.shields.io/github/downloads/Avazbek22/DevProjex/total"></a>
  <a href="https://github.com/Avazbek22/DevProjex/actions"><img alt="Build" src="https://img.shields.io/github/actions/workflow/status/Avazbek22/DevProjex/dotnet.yml"></a>
  <a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-blue"></a>
  <img alt="Last commit" src="https://img.shields.io/github/last-commit/Avazbek22/DevProjex">
  <img alt="Platforms" src="https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-green">
</p>

<p align="center">
  <strong>Turn a real codebase into clean, AI-ready context — and see exactly what you're sending.</strong>
</p>

DevProjex turns any folder or codebase into clean, ready-to-use context for AI chats, code reviews, and documentation. Use it as a **GUI**, a **TUI**, a **CLI**, or an **MCP server** for AI agents — whatever fits your workflow.

Choose what you need in an interactive file tree, check the result in a live preview, then export it as **ASCII, Markdown, JSON, or XML**. Need more than text? Export a real copy of your project — a clean **folder or ZIP file** — with the same filters applied.

> 🔒 **Read-only analysis and telemetry-free by design.** DevProjex does not upload your project contents or collect telemetry.

---

## App Demo 🖼️

<img src="Docs/Media/readme-demo/devprojex-demo.gif" alt="DevProjex demo: the desktop app and Terminal Workspace" width="100%" />

---

## Download 🚀

**Download from Microsoft Store:**
👉 [DevProjex](https://apps.microsoft.com/detail/9ndq3nq5m354)

**Latest GitHub release:**
👉 [https://github.com/Avazbek22/DevProjex/releases/latest](https://github.com/Avazbek22/DevProjex/releases/latest)

**Install via WinGet (Windows):** `winget install OlimoffDev.DevProjex`

All install options per OS are covered in [Docs/Installation.md](Docs/Installation.md).

### Run without installing

These headless channels are available from release v5.2. Until the v5.2 packages
have completed their first publication, use the direct GitHub release binary.

```shell
npx devprojex tree .
dnx devprojex tree .
./DevProjex tree .
```

The npm and NuGet packages contain the CLI, TUI, and MCP server, but not the
desktop application. See [Docs/Installation.md](Docs/Installation.md) for the
Node/.NET requirements and supported platforms.

Release automation also prepares direct headless archives and a non-root Docker
image; their commands and availability boundary are documented in
[Docs/Installation.md](Docs/Installation.md).

---

## Why DevProjex? 💡

Copying files into a chat window one by one **doesn't scale**. CLI tools pack a whole project fast, but you **can't see what you're sending** before it's sent.

DevProjex works differently — visual, precise, and local-first:

* **You see what leaves your project** — file tree, live preview, token estimate
* **You control what leaves it** — Smart Ignore, Git modes, secret and private-data redaction, name filters, saved profiles
* **You get more than text** — a real project copy as a folder or ZIP

### Use it for

* **AI assistants** — clean input for ChatGPT, Claude, DeepSeek, Qwen, Kimi
* **AI agents** — Claude Code, Cursor, or any MCP client inspects your project through a read-only, always-redacted server
* **CI pipelines** — fail a build when secrets would leak into packed context, without ever printing the values
* **Restricted environments** where AI agents, remote indexing, or IDE plugins aren't allowed
* **Code reviews** — share structure and only the files that matter
* **Large codebases** — pull out one module instead of the whole repo
* **Teaching** — explain a project's architecture to a teammate or student

### Get started

1. **Open or drop** a project folder.
2. **Choose** folders, files, filters, ignore rules, and output mode.
3. **Preview**, then copy, export, or run the same workflow from the terminal.

Works with any language, repository, or project structure.

---

## Feature overview ✨

**Choose and control**
* **Smart Ignore** — hides build output, dependency folders, and caches, and checks for evidence before hiding anything. [How it works ↓](#how-smart-ignore-works-)
* **Hide Secrets** — masks detected credential values in everything you export. [How it works ↓](#how-hide-secrets-and-hide-private-data-work-)
* **Hide private data** — optionally masks emails, IPs, MACs, phones, and user paths. [How it works ↓](#how-hide-secrets-and-hide-private-data-work-)
* **Code compression** — keeps declarations and signatures, empties implementation bodies; pure code gets ~3× smaller. [How it works ↓](#how-code-compression-works-)
* **Strip comments** and **strip blank lines** — syntax-aware cleanup across 20 language packs, without modifying source files
* File tree with checkboxes, search, and name filters
* Git-aware scopes for `.gitignore`, tracked files, staged files, all current changes, or a ref-to-ref diff

**Preview and export**
* Live preview (tree / content / both) before you copy or export
* Scrollbar markers show search matches and redaction findings at a glance
* Export as ASCII, Markdown, JSON, or XML
* Save to file or clipboard — tree only, content only, or both
* Export a clean copy of your project to a folder or ZIP archive

**Workflow**
* GUI, TUI, CLI, and MCP server — the same engine, four ways to work
* Git tools built in: clone by URL, switch branches, update cached copies
* Local profiles remember your settings per project
* Live counters for lines, characters, and estimated tokens
* Progress bar with safe cancellation

**Interface**
* Light, dark, and system themes, with transparency and blur where supported
* Platform-native keyboard shortcuts — ⌘-based on macOS, Ctrl-based on Windows and Linux
* Tree context menu — reveal in the file manager, copy paths or transformed contents, select one item, expand or collapse a branch
* Localization in 20 languages
* Stays smooth even on very large folders

---

## DevProjex vs the alternatives ⚖️

| Feature | DevProjex | Repomix | gitingest | code2prompt | GPTree | files-to-prompt |
|---|---|---|---|---|---|---|
| GUI + TUI + CLI + MCP — all in one app | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Built-in MCP server for AI agents | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
| Live preview that updates while you select | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Tracked-files-only Git mode | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Scope-aware, evidence-based Smart Ignore (monorepo-safe) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Value-level secret masking that keeps the file in output | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Private-data masking (emails, IPs, MAC, phones, user paths) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Signature-level code compression | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
| CI secret pre-flight gate (fail build on findings) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Export a clean project copy as folder/ZIP | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| GUI-managed Git workflow (clone, branch switch, cache updates) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Run with no install (npx / dnx / direct binary) | ✅ (v5.2+) | ✅ | ✅ | ❌ | ❌ | ✅ |

<sub>Based on publicly documented features, last verified September 2026. DevProjex no-install package channels are available from v5.2.</sub>

---

## Project Copy Export 📦

Use **File → Export project → To folder…** or **To ZIP archive…** to create a separate copy of your current selection.

Project copies respect your chosen root folders, file types, ignore rules, and checked items. If nothing is checked, the whole current tree is exported. Directory structure, binary files, and included empty folders are preserved.

When **Hide Secrets** or **Hide private data** is enabled, detected values in text files are replaced. Binary files remain unchanged. This result is intentionally not a byte-for-byte copy and may not build or run.

The source project is never modified, and the result can't be written inside it. The same workflow is available through `devprojex export project`.

---

## Command Line ⚙️

DevProjex isn't only a desktop context builder. The same app runs from the terminal too, for repeatable, script-friendly project analysis and AI-context export.

```bash
devprojex
devprojex open . --preview
devprojex tree .
devprojex tree https://github.com/owner/repo --branch main
devprojex analyze . --format json
devprojex analyze . --hide-secrets --hide-private-data --findings --fail-on-findings
devprojex export context . --format markdown -o ../devprojex-context.md
devprojex export context https://github.com/owner/repo -o -
git diff --name-only | devprojex export context . --select-from - -o -
devprojex export project . --as zip --hide-secrets -o ../devprojex-submission.zip
$ devprojex export project . --as zip -o - > devprojex-submission.zip
devprojex analyze . --git-mode tracked --exclude smart-ignore
devprojex search Configure . --symbols
devprojex related src/App.cs --direction both
devprojex profile save . --hide-secrets on
devprojex cache update https://github.com/owner/repo
```

### What the CLI adds

* Scriptable exports for CI pipelines — JSON reports, stdout output, deterministic files
* Git repository URLs as project sources — analyze, export, open, or start the TUI on a repository straight from its URL through a managed clone cache (`devprojex cache`, `devprojex recent`)
* A redaction pre-flight for CI — `--findings` lists rule, category, file, and source line (never the values), and `--fail-on-findings` fails the pipeline when findings exist
* Composable selection — pipe a file list from `git diff` or any tool into `--select-from -`
* Project search and relations — `devprojex search` finds text, `--regex` patterns, or declarations by name with `--symbols`; `devprojex related` lists the files a file uses and the files that us