Skip to content

feat: Add disk module collector and update documentation #4

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
dev-dami merged 2 commits into from
Dec 19, 2025
Merged

feat: Add disk module collector and update documentation #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24acf61
feat: Add disk module collector and update documentation
Dec 15, 2025
d8f7aba
Merge branch 'main' into main
dev-dami Dec 19, 2025
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
41 changes: 8 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ gim is a fast, high-performance, modular system metrics and diagnostics CLI tool

## Features

- **Modular Design**: Easy to extend with new metric collectors
- **Multiple Output Formats**: JSON, table, and raw output modes
- **Real-time Metrics**: CPU and memory usage statistics
- **Clean Architecture**: Well-structured codebase for easy maintenance
- *Modular Design*: Easy to extend with new metric collectors
- *Multiple Output Formats*: JSON, table, and raw output modes
- *Real-time Metrics*: CPU and memory usage statistics
- *Clean Architecture*: Well-structured codebase for easy maintenance

## Use Cases

Expand All @@ -22,45 +22,20 @@ gim is a fast, high-performance, modular system metrics and diagnostics CLI tool

```bash
# Clone the repository
git clone https://github.com/your-repo/gim.git
git clone [https://github.com/your-repo/gim.git](https://github.com/your-repo/gim.git)

# Build the project
cargo build --release

# Run with default settings
# Run with default settings (now includes CPU, Memory, and Disk)
cargo run
Comment on lines +25 to 31
Copy link

@coderabbitai coderabbitai bot Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix the git clone example so it’s a valid shell command.

Inside a fenced bash block, Markdown link syntax makes the command unusable when copy‑pasted. Also, you can point directly at this repo.

-# Clone the repository
-git clone [https://github.com/your-repo/gim.git](https://github.com/your-repo/gim.git)
+# Clone the repository
+git clone https://github.com/dev-dami/gim.git

This keeps the example runnable from the terminal.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
git clone [https://github.com/your-repo/gim.git](https://github.com/your-repo/gim.git)
# Build the project
cargo build --release
# Run with default settings
# Run with default settings (now includes CPU, Memory, and Disk)
cargo run
git clone https://github.com/dev-dami/gim.git
# Build the project
cargo build --release
# Run with default settings (now includes CPU, Memory, and Disk)
cargo run
🤖 Prompt for AI Agents 
In README.md around lines 25–31 the git clone example uses Markdown link syntax
which breaks when copy‑pasted; replace the link-style line with a plain git
clone command that points directly at this repository using the raw HTTPS URL
(for example https://github.com/your-repo/gim.git) and render it inside a fenced
bash block so the example is runnable from the terminal.


# Run a specific module
cargo run -- --module cpu
cargo run -- --module memory
cargo run -- --module disk # <--- Disk Module

# Use different output formats
cargo run -- --output json
cargo run -- --output raw
cargo run -- --module cpu --output json
```

## Current Capabilities

- **CPU Metrics**: Usage percentage, core count
- **Memory Metrics**: Total, used, free, available memory and swap
- **Output Options**: JSON, formatted table, or raw key-value pairs

## Planned Features

- Disk and network metric collectors
- TUI dashboard with ratatui
- Configuration file support
- Live monitoring capabilities

## Documentation

- [API Documentation](docs/api.md)
- [Architecture](docs/architecture.md)
- [Modules Guide](docs/modules.md)
- [Extending Guide](docs/extending.md)
- [Contributing](CONTRIBUTING.md)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
cargo run -- --module cpu --output json
2 changes: 1 addition & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ pub fn run() {
Err(e) => eprintln!("Error collecting {} metrics: {}", collector.name(), e),
}
}
}
}
Loading