devaudit-cli 0.3.0

Linux system inspection and developer environment audit tool

dev-audit

Project Status

Current Release: v0.3.0

Features

• Linux system inspection
• Resource monitoring
• Network auditing
• Developer tool validation
• Audit findings engine
• JSON output support
• Verbose output support
• Exit code support for automation
• GitHub Actions CI/CD

Quality Metrics

• 44 passing tests
• 50% code coverage
• Automated CI validation
• Semantic versioning
• Tagged releases

A Linux system inspection and diagnostic CLI built for Ubuntu environments.

dev-audit collects system information, resource metrics, network configuration, and developer environment details, then evaluates the results against audit rules to identify potential issues.

---

Features

System Audit

• Operating system information
• Kernel version
• Hostname
• Architecture
• User and shell
• System uptime

Resource Audit

• CPU core count
• Load averages
• Memory utilization
• Swap utilization
• Root filesystem usage

Network Audit

• Network interfaces
• Default route
• DNS configuration
• Listening TCP and UDP ports

Developer Environment Audit

• Python
• pip
• Git
• Docker
• Docker Compose
• Node.js
• npm

Audit Engine

Detects:

• Exposed SSH services
• HTTP services listening on all interfaces
• Inconsistent development tool installations
• WSL-specific tool resolution issues

Output Modes

• Human-readable terminal output
• JSON output
• Verbose diagnostics

Exit Codes

Exit Code	Meaning
0	Healthy audit
1	Findings detected
2	Collector failure

---

Architecture

dev-audit follows a modular collector-based architecture.

CLI
 │
 ├── System Collector
 │      ├── OS Information
 │      ├── Kernel Information
 │      └── Uptime
 │
 ├── Resource Collector
 │      ├── CPU Usage
 │      ├── Memory Usage
 │      ├── Swap Usage
 │      └── Disk Usage
 │
 ├── Network Collector
 │      ├── Interfaces
 │      ├── DNS Servers
 │      ├── Default Route
 │      └── Listening Ports
 │
 ├── DevTools Collector
 │      ├── Python
 │      ├── pip
 │      ├── Git
 │      ├── Docker
 │      ├── Docker Compose
 │      ├── Node.js
 │      └── npm
 │
 └── Audit Engine
        ├── Resource Checks
        ├── Network Checks
        └── Environment Checks

Output Layer
 ├── Human Readable Output
 ├── JSON Output
 └── Exit Codes

Design Goals

• Modular collector architecture
• Linux-first implementation
• Machine-readable JSON output
• Human-readable terminal output
• CI/CD validated
• Test-driven development
• Suitable for automation and scripting

Example Output

$ dev-audit

System Information
────────────────────────
Hostname      : ubuntu-server
OS            : Ubuntu 24.04 LTS
Kernel        : 6.8.0
Architecture  : x86_64
User          : ubuntu

Resource Usage
────────────────────────
CPU Cores      : 8
Load Average   : 0.10 0.12 0.08

Memory
──────
Total          : 16.0 GiB
Used           : 4.2 GiB
Available      : 11.8 GiB

Audit Findings
──────────────
⚠ SSH is listening on all interfaces.
⚠ HTTP service exposed on all IPv4 interfaces.

JSON Output

$ dev-audit --json

{
  "system": {
    "hostname": "ubuntu-server",
    "kernel": "6.8.0"
  },
  "findings": [
    "SSH is listening on all interfaces."
  ]
}

Use Cases

dev-audit can be used to:

• Quickly inspect Linux development environments
• Validate workstation setup before software development
• Audit servers for exposed services and configuration issues
• Generate machine-readable JSON reports for automation
• Troubleshoot networking and developer tool installations
• Perform lightweight health checks on Ubuntu systems

Installation

Clone Repository

git clone https://github.com/Bonbonjb/dev-audit.git
cd dev-audit

Create Virtual Environment

python3 -m venv .venv
source .venv/bin/activate

Install Package

pip install -e .

---

Usage

Full Audit

dev-audit

Run Individual Sections

dev-audit system
dev-audit resources
dev-audit network
dev-audit devtools

JSON Output

dev-audit --json

Verbose Output

dev-audit --verbose

---

Example Audit Findings

⚠ SSH is listening on all interfaces.
⚠ HTTP service exposed on all IPv4 interfaces.
⚠ npm detected but Node.js executable not found.

---

Running Tests

pytest

Current test suite:

44 passing tests

---

Project Structure

src/dev_audit/
├── audit.py
├── cli.py
├── command.py
├── output.py
├── status.py
└── collectors/
    ├── system.py
    ├── resources.py
    ├── network.py
    └── devtools.py

tests/
├── test_audit.py
├── test_command.py
├── test_network.py
├── test_output.py
├── test_resources.py
├── test_status.py
└── test_system.py

---

Roadmap

• GitHub Actions CI
• Coverage reporting
• Additional audit rules
• Package publishing
• Extended Linux distribution support