# 🔍 Verid
[](https://crates.io/crates/verid)
[](https://crates.io/crates/verid)
[](LICENSE)
[](https://www.rust-lang.org)
> ⚡ Fast. Minimal. Deterministic.
> One CLI to **format** and **audit** your codebase.
---
# ✨ What is Verid?
**Verid** is a high-performance CLI tool built in Rust that combines:
- 🧹 **Code formatter**
- 🔍 **Security & quality auditor**
into **one unified workflow**.
No config hell.
No plugin overload.
Just clean, fast, deterministic tooling.
---
# 💡 Why Verid?
Because modern dev workflows are messy.
You usually need:
- formatter
- linter
- security scanner
- style checker
➡️ Verid merges all of that into **one single binary**.
### 🧠 Designed for:
- ⚡ Fast CI pipelines
- 🧪 Deterministic codebases
- 🔐 Secure development practices
- 🧹 Clean formatting standards
---
# 🔥 Core Features
## 🧹 Formatting Engine
- Stable & idempotent formatting
- Indentation normalization
- Line width wrapping
- Multi-rule runner system
## 🔍 Audit Engine
- Static code scanning
- Security issue detection
- Reliability checks
- Code smell detection
## 🧠 Smart Filtering
- `--only-fail` → show only critical issues
- `--lang <ext>` → filter by language
- `--format json` → CI-friendly output
## ⚡ CLI First Design
- Zero config required
- Script-friendly
- Extremely fast execution
- Parallel scanning using Rayon
---
# 📦 Installation
## From crates.io
```bash
cargo install verid
```
## From Source
```bash
git clone https://github.com/sushiguard/verid
cd verid
git install --path .
```
---
# 🚀 Usage
## 🧹 Format code
```bash
verid format src/
```
Check only (CI mode):
```bash
verid format src/ --check
```
---
# 🔍 Audit Code
```bash
verid audit src/
```
Only show critical issues:
```bash
verid audit src/ --only-fail
```
Filter by language:
```bash
verid audit src/ --lang rs
```
JSON output (for CI pipelines):
```bash
verid audit src/ --format JSON
```
Combine everything:
```bash
verid audit src/ --lang rs --only-fail --format JSON
```
---
# 🧪 CI Integration
Verid is designed for CI.
**Example (GitHub Actions)**
```yaml
- name: Run Verid Audit
run: verid audit . --only-fail --format JSON
```
Exit codes:
| Code | Meaning |
|------|---------|
| 0 | No critical issues |
| 1 | Critical issues found |
---
# 🧠 Architecture
```
src/
├── formatter/
│ ├── indent.rs
│ ├── whitespace.rs
│ ├── width.rs
│ └── runner.rs
│
├── audit/
│ ├── scanner.rs
│ ├── detector.rs
│ ├── reporter.rs
│ └── mod.rs
│
├── cli.rs
└── main.rs
```
**Internal Engines**
| Engine | Responsibility |
|--------|-----------|
| Scanner | File discovery + language detection |
| Detector | Static analysis rules |
| Reporter | Output builder (Text/JSON) |
| Runner | Formatting rule executor |
---
# ⚙️ Philosophy
Verid follows strict engineering principles:
- **Deterministic** → same input, same output
- **Minimal** → no unnecessary features
- **Composable** → rule-based architecture
- **Fast** → parallel execution with Rayon
- **Strict** → security-first scanning rules
---
# 🛠 Development
Run checks:
```bash
cargo check
cargo clippy -- -D warnings
cargo test
```
Format code:
```bash
cargo fmt
```
---
# 🗺 Roadmap (v0.4+)
- Config file (verid.toml)
- Ignore patterns (.veridignore)
- Custom rule plugins
- SARIF output format
- Git pre-commit hooks
- Language expansion (Go, Java, etc)
---
🤝 Contributing
PRs are welcome.
Steps:
1. Fork repository
2. Create branch
3. Implement feature
4. Ensure:
° cargo fmt
° cargo clippy -- -D warnings
° cargo check
° cargo test
5. Open PR
---
# 🔐 Security
If you find a vulnerability:
Please report responsibly via issue or private contact.
---
# 📄 License
MIT License
---
# ❤️ Acknowledgements
Built with ❤️ using Rust.
Inspired by modern dev tooling:
- rustfmt
- clippy
- eslint
- cargo-audit
---
# ⭐ Support
If you like Verid:
- ⭐ Star the repo
- 📦 Use it in your projects
- 💻 Share with other devs
---
# 🚀 Verid
> Clean code. Secure code. Fast workflow.