Metadata-Version: 2.4
Name: test-ssd
Version: 0.1.4
Summary: UGREEN NAS NVMe SSD screening CLI
Author: Codex
Keywords: nvme,ssd,fio,smartctl,nas,ugreen
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# SSD Test CLI

`test-ssd` is a Python 3 CLI for screening refurbished NVMe SSDs on a UGREEN NAS or another Linux host with `smartctl`, `nvme-cli`, `fio`, `lsblk`, and `dmesg` installed.

## Install

From PyPI:

```bash
pipx install test-ssd
```

or:

```bash
pip install test-ssd
```

From this project directory:

```bash
./install.sh
```

That installs the package into the current Python environment and exposes both `test-ssd` and `ssdtest` as shell commands.

If `~/.local/bin` is not already on your `PATH`, add it once:

```bash
export PATH="$HOME/.local/bin:$PATH"
```

## Commands

```bash
test-ssd scan
test-ssd run --label bb-refurb-01
test-ssd history
test-ssd show <run_id>
```

Module entry point:

```bash
python3 -m ssdtest scan
```

## Notes

- `run` requires root.
- The destructive test writes the full target device.
- Reports default to `/root/nvme-tests` and include raw command outputs, `report.json`, and `report.md`.
