# BleachBit

BleachBit cleans files to free disk space and to maintain privacy.

## Running from source

To run BleachBit without installation, first install the system dependencies,
then build the translations and run it:

```sh
make install-deps       # runtime deps (auto-detects Debian/Fedora/openSUSE/Arch)
make -C po local        # build translations
python3 bleachbit.py
```

Many Linux systems have the basic dependencies: you may skip installation,
but in case of any issues, please check for missing dependencies.

Then, review the preferences.

Then, select some options, and click Preview.  Review the files, toggle options accordingly, and click Delete.

For information regarding the command line interface, run:

```sh
python3 bleachbit.py --help
```

Read more about [running from source](https://docs.bleachbit.org/dev/running-from-source-code.html).

## Links

* [BleachBit home page](https://www.bleachbit.org)
* [Support](https://www.bleachbit.org/help)
* [Documentation](https://docs.bleachbit.org)

## Localization

Read [translation documentation](https://www.bleachbit.org/contribute/translate) or translate now in [Weblate](https://hosted.weblate.org/projects/bleachbit/), a web-based translation platform.

<a href="https://hosted.weblate.org/engage/bleachbit/">
      <img src="https://hosted.weblate.org/widgets/bleachbit/-/multi-auto.svg" alt="Translation status"/>
</a>

## Licenses

BleachBit itself, including source code and cleaner definitions, is licensed under the [GNU General Public License version 3](COPYING), or at your option, any later version.

markovify is licensed under the [MIT License](https://github.com/jsvine/markovify/blob/master/LICENSE.txt).

## Development

To develop, run the test suite, or build packages, install the
extra build/test/lint/packaging tools too:

```sh
make install-deps-dev
```

Common commands include:

```sh
make tests   # run tests
make lint    # check .py and .sh files for issues
make pretty  # format .py and .xml files
```

More resources:
* [![Build and Test](https://github.com/bleachbit/bleachbit/actions/workflows/build_and_test.yaml/badge.svg?branch=master)](https://github.com/bleachbit/bleachbit/actions/workflows/build_and_test.yaml)
* [![Run tests on macOS](https://github.com/bleachbit/bleachbit/actions/workflows/test_macos.yaml/badge.svg?branch=master)](https://github.com/bleachbit/bleachbit/actions/workflows/test_macos.yaml)
* [CleanerML Repository](https://github.com/bleachbit/cleanerml)
* [BleachBit Miscellaneous Repository](https://github.com/bleachbit/bleachbit-misc)
* [Winapp2.ini Repository](https://github.com/bleachbit/winapp2.ini)

### Docker-based Linux builds

The `docker/build.sh` script sets up a container, runs `make tests`,
and builds packages for a selected distribution. Usage:

```sh
./docker/build.sh <distro> # distro is one of {debian, fedora, opensuse}
```

Artifacts are copied to `./docker-artifacts/<distro>` on the host.