You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](CODE_OF_CONDUCT.md)
6
6
7
-
**CodeSleuth** is a high-performance, multi-language code intelligence CLI tool designed for legacy COBOL analysis. Built with Rust and Go, it provides fast parsing, comprehensive analysis, and actionable insights for enterprise codebases.
7
+
**CodeSleuth** is a code intelligence CLI tool for analyzing legacy COBOL codebases. It is built with Rust and Go, providing a modular architecture for parsing, analysis, and reporting.
8
8
9
9
---
10
10
11
-
## 🚀 Features
11
+
## Features
12
12
13
-
-**⚡ High-Performance Parsing:** Rust-based COBOL parser with 10-50x faster processing
14
-
-**📊 Comprehensive Analysis:** Program structure, data division, procedure logic, call/control flow, and I/O analysis
15
-
-**📝 Rich Markdown Reports:** Detailed summaries with Mermaid diagrams for call and control flow visualization
16
-
-**🔍 Dead Code Detection:** Identifies unused paragraphs and variables
17
-
-**🏗️ Modular Architecture:** Clean separation between parser, CLI, and summarizer components
18
-
-**🔧 Modern CLI:** Intuitive command-line interface with verbose/debug options
19
-
-**🛡️ Security Focused:** Comprehensive security policy and responsible disclosure
20
-
-**🔄 CI/CD Ready:** Automated testing and linting via GitHub Actions
13
+
-**COBOL Parsing:** Rust-based parser for extracting program structure and metadata
14
+
-**Analysis & Summarization:** Generates Markdown reports with program structure, data division, procedure logic, call/control flow, and I/O analysis
15
+
-**Dead Code Detection:** Identifies unused paragraphs and variables
16
+
-**Call & Control Flow Visualization:** Mermaid diagrams for call and control flow
17
+
-**Modern CLI:** Go-based command-line interface with verbose/debug options
18
+
-**Cross-platform:** Runs on Windows, macOS, and Linux
19
+
-**CI/CD Ready:** Automated testing and linting via GitHub Actions
21
20
22
21
---
23
22
24
-
## 🛠️ Architecture
23
+
## Architecture
25
24
26
-
CodeSleuth uses a modern, efficient architecture:
27
-
28
-
-**Rust Parser** (`parser/`): Fast COBOL parsing and IR generation
CodeSleuth is designed to work out-of-the-box with minimal configuration. The tool automatically detects COBOL files (`.cob`, `.cbl`, `.cobol`) and generates appropriate analysis reports.
100
+
CodeSleuth works out-of-the-box. It automatically detects COBOL files (`.cob`, `.cbl`, `.cobol`) and generates analysis reports. No additional configuration is required for standard use cases.
105
101
106
102
---
107
103
108
-
## 🤝 Contributing
109
-
110
-
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on:
104
+
## Contributing
111
105
112
-
- Code style and standards
113
-
- Testing requirements
114
-
- Pull request process
115
-
- Issue reporting
106
+
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on code style, testing, pull requests, and issue reporting.
116
107
117
108
---
118
109
119
-
## 🛡️ Security
110
+
## Security
120
111
121
-
Found a security vulnerability? Please review our [Security Policy](SECURITY.md) for responsible disclosure guidelines.
112
+
If you discover a security vulnerability, please see [SECURITY.md](SECURITY.md) for responsible disclosure guidelines.
122
113
123
114
---
124
115
125
-
## 📄 License
116
+
## License
126
117
127
-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
118
+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
0 commit comments