Skip to content

Update README formatting and wording for clarity #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hmza-hb merged 1 commit into from
Oct 17, 2026
Merged

Update README formatting and wording for clarity #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cortex
# Cortex CLI

**A three-stage CLI that audits your codebase for security vulnerabilities, architectural issues, and dependency risks — with AI-powered explanations.**
**A three-stage CLI that audits your codebase for security vulnerabilities, architectural issues, and dependency risks, with AI-powered explanations.**

Local-first. No data leaves your machine. Works with Ollama, OpenAI, Anthropic, or any OpenAI-compatible API.

Expand Down Expand Up @@ -74,13 +74,13 @@ cortex scan . --severity high

## The three stages

### Stage 1 — Reconnaissance
### Stage 1, Reconnaissance
Cortex first builds a complete picture of your codebase before raising any issues: file structure, tech stack, framework detection, dependency graph, HTTP endpoints, and infrastructure config files.

### Stage 2 — Security scanning
### Stage 2, Security scanning
A suite of detectors runs against the recon data, searching for security vulnerabilities: hardcoded secrets, injection risks, insecure dependencies, JWT misconfigurations, CORS issues, and more.

### Stage 3 — Architecture analysis
### Stage 3, Architecture analysis
Cortex measures the health of your architectural decisions: god files, circular dependencies, missing error handling, dead code, and test coverage gaps.

---
Expand Down Expand Up @@ -157,8 +157,8 @@ We welcome new detectors, language support, and bug fixes. See [CONTRIBUTING.md]

## License

MIT — see [LICENSE](LICENSE).
MIT, see [LICENSE](LICENSE).

---

Built by [Hamza Hafeez](https://github.com/hamza-hafeez82) · [cortex-edr.com](https://cortex-edr.com)
Built by [Hamza Hafeez](https://github.com/hamza-hafeez82) · [cortex-edr.com](https://cortex-edr.com)
Loading