|Mar 1, 2023
|Mar 1, 2023
|Jan 23, 2023
|Dec 2, 2022
#584 in Filesystem
39 downloads per month
This is a command line tool for Bread for finding relevant projects. You can use it to update personal donations or to generate a
.bread.yml file for a project.
Supported dependency files:
package.json(requires a populated
node_modulesdirectory for metadata)
Supported operating systems for scanning:
bread-scan is written in Rust, and you can install
bread-scan using the Rust package manager https://doc.rust-lang.org/cargo/:
cargo install bread-scan
You'll need to set up a token at https://bre.ad/tokens with config read and write permission, and put it in an environment variable named
bread-scan -s os=debian -d donate
This scans your system for manually installed packages and tries to figure out the corresponding repository, then updates your donation configuration with them.
The results will be merged with your existing donation targets, keeping existing weights. If you want to remove software you're no longer using, use
If you're generating a yaml file for your project, you can use the following invocation.
bread-scan -s project=. -d project_yaml=.
bread-scan will look for dependencies in the project at the current directory using common dependency management systems (
This will merge with an existing yaml file if it exists, preserving existing weights. It will keep projects even if it didn't find them during a scan. You can use
--remove to have it remove them (or similarly,
--remove-accounts for accounts).
Commit and push this file and your project is ready to accept (and redistribute) donations!
Source and dest types
file= source/dest arguments can be used for storing results locally for manual editing, local management, etc. It is in a JSON format only used by
DEBUG=1 for more log messages.
Various lookups are cached to make updating configs faster. The configs are stored in your system's user cache
bread-scan directory. On linux, with XDG paths, this would be
/home/USER/.cache/bread-scan. You may delete the directory, remote resources will need to be re-queried on the next run.