https://github.com/openaev-platform/agent
OpenAEV Agent
https://github.com/openaev-platform/agent
agent bas filigran openbas
Last synced: 3 months ago
JSON representation
OpenAEV Agent
- Host: GitHub
- URL: https://github.com/openaev-platform/agent
- Owner: OpenAEV-Platform
- License: apache-2.0
- Created: 2024-06-01T11:47:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-12T16:45:05.000Z (5 months ago)
- Last Synced: 2026-01-12T21:57:49.996Z (5 months ago)
- Topics: agent, bas, filigran, openbas
- Language: NSIS
- Homepage: https://openaev.io
- Size: 458 KB
- Stars: 10
- Watchers: 2
- Forks: 6
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OpenAEV Agent
[](https://openaev.io)
[](https://circleci.com/gh/OpenAEV-Platform/agent/tree/main)
[](https://github.com/OpenAEV-Platform/agent/releases/latest)
[](https://community.filigran.io)
The following repository is used to store the OpenAEV agent for the platform. For performance and low level access, the agent is written in Rust. Please start your journey with https://doc.rust-lang.org/book.
---
## 🚀 Installation
Agent installation is fully managed by the OpenAEV platform.
You can find more information on the [official documentation](https://docs.openaev.io/latest/usage/openaev-agent/?h=agent).
## 🛠 Development
The agent is written in [Rust](https://www.rust-lang.org/). If you're new to Rust, start with [The Rust Book](https://doc.rust-lang.org/book).
### Prerequisites
- [Rust](https://rustup.rs/)
- [Cargo](https://doc.rust-lang.org/cargo/)
- Linux, macOS, or Windows
### Build
```bash
cargo build
```
---
## ✅ Running Tests
Run all tests (unit + integration):
```bash
cargo test
```
Run a specific test:
```bash
cargo test test_name
```
---
## 📊 Code Coverage
Requires [`cargo-llvm-cov`](https://github.com/taiki-e/cargo-llvm-cov):
```bash
cargo install cargo-llvm-cov
cargo llvm-cov --html
```
---
## 🧹 Code Quality Guidelines
### Clippy
Run locally:
```bash
cargo clippy -- -D warnings
```
Auto-fix:
```bash
cargo fix --clippy
```
Clippy runs in CI — all warnings must be fixed for the pipeline to pass.
---
### Rustfmt
Check formatting:
```bash
cargo fmt -- --check
```
Fix formatting:
```bash
cargo fmt
```
Rustfmt runs in CI to enforce formatting.
---
### Cargo Audit
Check dependencies for known vulnerabilities:
```bash
cargo audit
```
Update vulnerable packages:
```bash
cargo update
```
Audit is included in CI to block new vulnerabilities.
---
## 🧪 Tests in CI
All tests are run automatically in the CI pipeline using:
```bash
cargo test
```
Builds will fail if any tests or quality checks fail.
---
## 🛠 Troubleshooting in Development Mode
When running the agent in development mode using:
```bash
cargo run -- start
```
All logs are written to:
```
target/debug/openaev-agent.log
```
Check this file if something isn’t working or you need to debug an issue locally.
---
## 🧬 About
OpenAEV is developed by [Filigran](https://filigran.io), a company dedicated to building open-source security tooling.
