|
6 | 6 |
|
7 | 7 | [](https://go.dev/) |
8 | 8 | [](LICENSE) |
9 | | -[](docs/implementation_plan_todo.md) |
| 9 | +[](https://github.com/greysquirr3l/shadowforge/releases) |
10 | 10 | [](https://github.com/greysquirr3l/shadowforge) |
11 | 11 | [](https://github.com/greysquirr3l/shadowforge) |
| 12 | +[](https://github.com/greysquirr3l/shadowforge) |
| 13 | +[](https://github.com/greysquirr3l/shadowforge) |
12 | 14 |
|
13 | 15 | **Shadowforge** is a production-grade quantum-resistant steganography tool that combines |
14 | 16 | NIST-approved post-quantum cryptography, Reed-Solomon error correction, and multiple |
@@ -61,14 +63,18 @@ with `K-of-N` threshold recovery. |
61 | 63 |
|
62 | 64 | ## 📈 Project Statistics |
63 | 65 |
|
64 | | -- **Total Lines**: ~15,000+ (implementation + tests) |
| 66 | +- **Total Lines**: 60,322 (44,174 code, 6,654 comments, 9,494 blanks) |
| 67 | +- **Go Code**: 41,671 lines across 185 files |
| 68 | +- **Comment Ratio**: 13% (5,385 comment lines) |
| 69 | +- **Languages**: Go (primary), Python, Shell, Markdown, Makefile |
65 | 70 | - **Bounded Contexts**: 8 (Crypto, Error Correction, Stego, Media, Analysis, Distribution, Reconstruction, Archive) |
66 | | -- **Implementation Files**: 83+ |
67 | | -- **Test Files**: 50+ |
| 71 | +- **Implementation Files**: 185+ Go files |
| 72 | +- **Test Files**: 50+ comprehensive test suites |
68 | 73 | - **Test Coverage**: 85%+ (90%+ for crypto operations) |
69 | 74 | - **Distribution Patterns**: 4 (all operational) |
70 | 75 | - **Steganography Techniques**: 7/7 (100% complete) |
71 | 76 | - **CLI Binary Size**: 8.2MB (fully self-contained) |
| 77 | +- **Shell Completions**: Bash, Fish, Zsh (all commands covered) |
72 | 78 |
|
73 | 79 | ## 🏗️ Architecture |
74 | 80 |
|
@@ -193,6 +199,8 @@ to evade steganalysis detection. |
193 | 199 |
|
194 | 200 | ## 📚 Documentation |
195 | 201 |
|
| 202 | +**🌐 Web Documentation**: [greysquirr3l.github.io/shadowforge](https://greysquirr3l.github.io/shadowforge/) |
| 203 | + |
196 | 204 | Complete documentation available in [`docs/public/cli/`](docs/public/cli/): |
197 | 205 |
|
198 | 206 | **Getting Started:** |
@@ -247,6 +255,17 @@ make build |
247 | 255 |
|
248 | 256 | # Run tests |
249 | 257 | make test |
| 258 | + |
| 259 | +# Optional: Install shell completions |
| 260 | +# Bash |
| 261 | +sudo cp scripts/completion/shadowforge.bash /etc/bash_completion.d/shadowforge |
| 262 | + |
| 263 | +# Fish |
| 264 | +cp scripts/completion/shadowforge.fish ~/.config/fish/completions/shadowforge.fish |
| 265 | + |
| 266 | +# Zsh |
| 267 | +cp scripts/completion/shadowforge.zsh ~/.zsh/completion/_shadowforge |
| 268 | +# Add to ~/.zshrc: fpath=(~/.zsh/completion $fpath) |
250 | 269 | ``` |
251 | 270 |
|
252 | 271 | ## 🚀 Quick Start |
@@ -356,7 +375,9 @@ curl -X POST http://localhost:8080/api/v1/embed \ |
356 | 375 |
|
357 | 376 | ## 📊 Development Status |
358 | 377 |
|
359 | | -### Current Phase: **Phase 5 Complete — API deferred (future item); CI/CD + Homebrew prep underway** |
| 378 | +### Current Version: **v0.7.6** (December 2025) |
| 379 | + |
| 380 | +### Current Phase: **Phase 5 Complete — CLI Production Ready** |
360 | 381 |
|
361 | 382 | | Phase | Status | Description | |
362 | 383 | |-------|--------|-------------| |
@@ -541,9 +562,11 @@ and security purposes only. Always comply with applicable laws and regulations. |
541 | 562 |
|
542 | 563 | ## 🔗 Links |
543 | 564 |
|
| 565 | +- **Website**: <https://greysquirr3l.github.io/shadowforge> |
544 | 566 | - **GitHub**: <https://github.com/greysquirr3l/shadowforge> |
545 | | -- **Documentation**: [docs/public/cli/architecture.md](docs/public/cli/architecture.md) |
| 567 | +- **Documentation**: [docs/public/cli/](https://greysquirr3l.github.io/shadowforge/cli/) |
546 | 568 | - **Issues**: <https://github.com/greysquirr3l/shadowforge/issues> |
| 569 | +- **Releases**: <https://github.com/greysquirr3l/shadowforge/releases> |
547 | 570 |
|
548 | 571 | --- |
549 | 572 |
|
|
0 commit comments