gfas-api 0.3.9

Sync GitHub followings to followers
Documentation

gfas

gfas (GitHub Following Auto Synchronization) manipulates your GitHub following list to match your followers, enabling you to follow back and unfollow back automatically. It runs on CLI and can be scheduled with GitHub Actions.

GitHub Actions Coverage Crates.io Downloads License

Usage

GitHub Actions

  • Copy-paste the Sync workflow to any of your repositories. You can just fork this repository for convenience.
  • Create a personal access token with the user:follow permission.
  • Create an secret named TOKEN in the repository containing the token value.
  • Customize your workflow, e.g. modify the scheduled time (defaults to every 6 hours).
  • Maybe you want to trigger it manually to see the effect.

CLI

$ cargo install gfas-cli
$ gfas sync -u <your-username> -t <your-token>

Run gfas --help for all commands and options.

API

The gfas-api crate exports some GitHub API bindings which can be used to build your application.

$ cargo add gfas-api
use gfas_api::GitHub;

let github = GitHub::with_token("<TOKEN>")?;

github.follow("<USER-TO-FOLLOW>").await?;

Development

$ git clone https://github.com/jwcub/gfas.git
$ cd gfas
$ cargo run -- --help

Contributing

See CONTRIBUTING.md.

License

This project is licensed under the Unlicense.