Metadata-Version: 2.4
Name: checkdisk
Version: 0.1.0
Summary: Dependency-free NTFS repair tool — the chkdsk /f flow on raw devices and images
License-Expression: 0BSD
Project-URL: Homepage, https://github.com/h5rdly/checkdisk
Keywords: ntfs,chkdsk,filesystem,repair,recovery,forensics,mft
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: System :: Recovery Tools
Requires-Python: >=3.13
Description-Content-Type: text/markdown

# checkdisk

A self-contained, pure-Python NTFS repair tool — the parts of `chkdsk /f` that matter for a crashed volume (dangling dirents, torn indexes, 
lost files, torn truncates, `$Bitmap`, `$Secure`, the USN journal). 

`checkdisk` uses a native read/write engine that parses and rewrites on-disk NTFS structures directly, with multi-sector fixups and plan-then-commit 
atomicity. 

## Install

```
pip install checkdisk       
```

Or skip installing — `checkdisk.py` is self contained

## Quick start

`checkdisk` works on the raw (unmounted) device or an image file — never through
a mount:

```sh
checkdisk list                        # find NTFS partitions (mounts nothing)
sudo umount /mnt/point                # get off the volume first
sudo setfacl -m u:$USER:rw /dev/sdXN  # or run the tool with sudo
checkdisk /f /dev/sdXN                # dry run: reports, writes nothing
checkdisk /f /dev/sdXN --really       # repair (each fix re-verified)
checkdisk /f /dev/sdXN                # confirm: expect 0 remaining
```

`/r` adds the full surface read. Running from the repo instead:
`python checkdisk.py /f ...` — identical.
