{"id":25120207,"url":"https://github.com/allansomensi/inkcheck","last_synced_at":"2025-08-08T14:08:39.813Z","repository":{"id":275600836,"uuid":"926585679","full_name":"allansomensi/inkcheck","owner":"allansomensi","description":"A CLI tool to quickly check printer supplies status via SNMP. Made with Rust.","archived":false,"fork":false,"pushed_at":"2025-06-27T15:10:28.000Z","size":85,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-27T15:44:54.147Z","etag":null,"topics":["cli","printer-management","rust","snmp"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/allansomensi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-03T14:18:16.000Z","updated_at":"2025-06-27T15:09:56.000Z","dependencies_parsed_at":"2025-05-07T06:45:17.546Z","dependency_job_id":null,"html_url":"https://github.com/allansomensi/inkcheck","commit_stats":null,"previous_names":["allansomensi/inkcheck"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/allansomensi/inkcheck","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allansomensi%2Finkcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allansomensi%2Finkcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allansomensi%2Finkcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allansomensi%2Finkcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allansomensi","download_url":"https://codeload.github.com/allansomensi/inkcheck/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allansomensi%2Finkcheck/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269432993,"owners_count":24415971,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-08T02:00:09.200Z","response_time":72,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","printer-management","rust","snmp"],"created_at":"2025-02-08T05:19:59.176Z","updated_at":"2025-08-08T14:08:39.779Z","avatar_url":"https://github.com/allansomensi.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# InkCheck 🖨️\n\n**InkCheck** is a CLI tool built in Rust that checks printer supply levels via `SNMP`. It provides a fast and efficient way to monitor the status of **toner**, **drum**, **fuser** and other consumables for both **color** and **monochrome** printers directly from the command line.\n\n![preview](https://github.com/user-attachments/assets/97243faf-8140-40cb-b43d-a0953070f4b7)\n\n\n## 🚀 Getting Started\n\n### Prerequisites\n- **Rust** (latest stable version).\n\n### Cloning the Repository\n```bash\ngit clone https://github.com/allansomensi/inkcheck.git\ncd inkcheck\n```\n\n### Development Setup\nTo use the development scripts, install `just`:\n\n```elixir\ncargo install just\n```\n\n## 📦 Installation\nTo install from the source:\n\n```elixir\ncargo install --path .\n```\n\n## 🔧 Usage\nRun with the following command:\n\n```elixir\ninkcheck [IP] [OPTIONS]\n```\n\n### Options:\n\n- `-p, --port [PORT]`            - SNMP service port **(default: 161)**\n- `-s, --snmp-version [VERSION]` - SNMP version **(default: v2c)**\n- `-c, --community [COMMUNITY]`  - SNMP community **(default: public)**\n- `-t, --timeout [TIMEOUT]`      - Timeout in seconds **(default: 5)**\n- `-d, --data-dir [DIR]`         - Data directory\n- `--theme [THEME]`              - CLI theme **(default: solid)**\n- `-e, --extra_supplies`         - Show extra supplies informations\n- `-h, --help`                   - Display help information\n- `-V, --version`                - Display version information\n\n### Example:\nTo check the supply levels of a printer at `192.168.1.10`, using the `moon` theme, displaying `extra supplies`, and setting a `timeout` of 10 seconds:\n\n```elixir\ninkcheck 192.168.1.10 --theme moon -e -t 10\n```\n\n## 🎨 Themes\nSupports multiple visual themes for better readability and personalization. Below are the available themes:\n\n- Solid\n- Shades\n- Moon\n- Circles\n- Stars\n- Vintage\n- Diamonds\n- Blocks\n- Emoji\n\n---\n\n## 🖨️ Tested Printers\nBelow is a list of printers that have been tested:\n\n- Brother MFC-L6702DW\n- Brother DCP-8157DN\n- Brother DCP-8152DN\n- Brother MFC-7460DN\n- Brother MFC-L8900CDW\n- Brother DCP-L5652DN\n- Brother MFC-J6935DW\n- Brother HL-L2360DW\n- Brother HL-5350DN\n- Brother L2540\n- OKI B431\n- Xerox C8030\n\nIf you've tested with another printer model, feel free to contribute by adding it to the list!\n\n---\n\n## 📬 Contributing\nContributions are welcome! Feel free to open issues or submit pull requests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallansomensi%2Finkcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallansomensi%2Finkcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallansomensi%2Finkcheck/lists"}