Skip to content

Commit 13b7f95

Browse files
author
Flamehaven CI
committed
README cleanup: remove front matter, drop pro language, clarify spicy
1 parent 5a58e5f commit 13b7f95

File tree

1 file changed

+16
-58
lines changed

1 file changed

+16
-58
lines changed

README.md

Lines changed: 16 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,4 @@
1-
---
2-
title: dir2md + Spicy - Repository to Markdown Converter
3-
emoji: ?뱛
4-
colorFrom: blue
5-
colorTo: green
6-
sdk: gradio
7-
sdk_version: 5.45.0
8-
app_file: demo/app.py
9-
pinned: false
10-
license: mit
11-
short_description: LLM-ready markdown + spicy risk blueprints
12-
tags:
13-
- developer-tools
14-
- markdown
15-
- repository-analysis
16-
- llm
17-
- code-analysis
18-
- python
19-
---
20-
21-
癤? Dir2md +spicy
22-
1+
# Dir2md +spicy
232
![Dir2md Logo](./dir2md-logo.png)
243

254
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -33,12 +12,12 @@ Dir2md analyzes directory structures and generates comprehensive markdown docume
3312

3413
**Legend**: [*] Core Feature | [#] Security | [!] Performance | [T] Configuration | [+] User Experience | [o] Fresh in this release
3514

36-
## 1.1.0 Highlights
15+
## 1.1.x Highlights
3716

3817
- **[*] Fast preset**: `--fast` builds tree + manifest only (no file reads) for ultra-light contexts.
3918
- **[o] AI-friendly defaults**: `--ai-mode` with capped budgets, stats, manifest on; `--query` ranks files and injects snippets.
4019
- **[+] Dual outputs by default**: Generates human `md` and LLM-friendly `jsonl` together unless you choose `--output-format`.
41-
- **[#] Spicy risk report**: On by default (`--spicy`); disable with `--no-spicy`. Adds 5-level findings to md/json/jsonl/manifest; `--spicy-strict` fails on high/critical.
20+
- **[#] Spicy risk report**: On by default (`--spicy`); disable with `--no-spicy`. Adds 5-level findings to md/json/jsonl/manifest; `--spicy-strict` fails on high/critical.
4221
- **[T] CLI polish**: `[LEVEL]` status lines, `--progress none|dots|full`, timestamped `*_blueprint[_spicy]_YYYYMMDD` filenames.
4322
- **[&] Architecture**: Introduced `walker.py`, `selector.py`, `renderer.py`, `orchestrator.py` to reduce `core.py` coupling.
4423
- **[W] Release**: Added PyPI/TestPyPI release workflow and Docker usage notes.
@@ -191,38 +170,16 @@ pattern_files = ["file://./.dir2md/patterns.txt"]
191170
|--------|--------------|----------|-------|----------|
192171
| `raw` | Unlimited | inline | Off | Development, full code review |
193172
| `pro` | User-defined | User-defined | Custom | Production use, CI/CD, tuned budgets |
194-
| `ai` | ??000 (cap) | ref | 16-bit | LLM context prep with query prioritization |
173+
| `ai` | 6000 (cap) | ref | 16-bit | LLM context prep with query prioritization |
195174
| `fast` | n/a | off | 16-bit | Tree + manifest only (no contents), ultra-lightweight |
196175

197176
## Limitations (Current OSS Build)
198177
- The `raw` preset always forces `--emit-manifest` off; select `pro` when you need manifest output.
199178
- This enhanced version is distributed via GitHub only; the PyPI `dir2md` package is maintained separately by IsaacBreen with different features.
200-
- README references Pro-only capabilities (advanced masking, parallel processing, export formats) that are not implemented in this repository.
201-
202-
## Open-Core Model
203-
204-
### Free (OSS) Features
205-
- Complete directory analysis.
206-
- Token optimization and sampling.
207-
- SimHash deduplication.
208-
- Enhanced security masking (AWS access keys, bearer tokens, private keys, GitHub PATs, generic API keys, database URLs, JWTs, OAuth secrets).
209-
- All output modes and presets.
210-
- Deterministic builds.
211-
212-
### Pro Features
213-
- Advanced security masking (additional cloud and SaaS patterns).
214-
- Parallel processing and caching.
215-
- Language-specific analysis plugins.
216-
- HTML/PDF export options.
217-
- Team integration (CI/CD, PR bots).
218-
- Priority support.
219-
- Pricing and licensing: Open and free to use; see `FEATURES.md` for capability notes.
220-
221-
[Learn more about Pro features](FEATURES.md)
222179

223180
## Documentation
224181

225-
- **[Feature Comparison](FEATURES.md)** - Complete OSS vs Pro breakdown.
182+
- **[Feature Documentation](FEATURES.md)** - Detailed capabilities.
226183
- **[Current Status](CURRENT_FEATURES.md)** - What's implemented now.
227184
- **[Usage Examples](USAGE_EXAMPLES.md)** - Hands-on guide with examples.
228185

@@ -245,7 +202,7 @@ dir2md [path] -o output.md --preset [pro|raw|ai|fast]
245202
--only-ext "py,js,ts" # File extensions only
246203

247204
# Security
248-
--masking [off|basic|advanced] # Secret masking level (advanced requires Pro)
205+
--masking [off|basic|advanced] # Secret masking level (advanced adds extra patterns)
249206
--mask-pattern "api_key\\s*=\\s*['\\\"]?[A-Za-z0-9]+['\\\"]?" # Repeatable custom regex
250207
--mask-pattern-file file://./patterns.json # Load regex patterns (JSON array or newline list)
251208

@@ -331,11 +288,11 @@ Raw code slice for local agents:
331288
dir2md . --preset raw --masking basic --budget-tokens 4000
332289
```
333290

334-
### Spicy risk report
335-
- Spicy on by default. Disable with `--no-spicy`
336-
- Enforce failure on high/critical: `--spicy --spicy-strict` (exit code 2)
337-
- Outputs:
338-
- `md` (human-friendly): includes ?쏶picy??section
291+
### Spicy risk report
292+
- Spicy on by default. Disable with `--no-spicy`
293+
- Enforce failure on high/critical: `--spicy --spicy-strict` (exit code 2)
294+
- Outputs:
295+
- `md` (human-friendly): includes ??턯icy??section
339296
- `json`/`jsonl`/manifest (LLM-friendly): `spicy.score`, `spicy.counts`, `spicy.findings[]`
340297
Severity levels: ok, warn, risk, high, critical.
341298

@@ -374,8 +331,8 @@ For additional support:
374331

375332
## SIDRCE Certification
376333

377-
- **Certification ID**: SIDRCE-DIR2MD-20251203-廓-ARCHON
378-
- **Scores**: Integrity 98, Resonance 95, Stability 95, 廓-Score 96 (Certified)
334+
- **Certification ID**: SIDRCE-DIR2MD-20251203-兩?ARCHON
335+
- **Scores**: Integrity 98, Resonance 95, Stability 95, 兩?Score 96 (Certified)
379336
- The spicy refactor distributed responsibilities across `walker`, `selector`, `renderer`, and `orchestrator`, eliminating the former god-object risk.
380337
- pytest defaults are captured in `pytest.ini` (cache_dir, pythonpath) to keep runs deterministic across environments.
381338
- Join discussions in [GitHub Discussions](https://github.com/Flamehaven/dir2md/discussions)
@@ -388,9 +345,10 @@ This project shares its name with [IsaacBreen's dir2md](https://pypi.org/project
388345

389346
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
390347

391-
Pro features are available under a separate commercial license.
392-
393348
---
394349

395350
Made with care by Flamehaven for developers who want their AI to understand their code.
396351

352+
353+
354+

0 commit comments

Comments
 (0)