Browse Source

Merge pull request #106 from weskerfoot/docs

add help output to readme
pull/108/head
Wesley Kerfoot 4 years ago
committed by GitHub
parent
commit
98c20b2f9a
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 22
      README.md

22
README.md

@ -26,6 +26,28 @@ git+https://github.com/weskerfoot/DeleteFB.git`
4) Use the docker image (experimental) by running `make` after checking this repository out with git. There is also an image built and published automatically at `wjak56/deletefb:latest`
## How To Use It
```
usage: deletefb [-h] [-M {wall,unlike_pages,conversations}] -E EMAIL [-P PASSWORD] -U PROFILE_URL [-F TWO_FACTOR_TOKEN] [-H] [--no-archive] [-Y YEAR]
[-B CHROMEBIN]
optional arguments:
-h, --help show this help message and exit
-M {wall,unlike_pages,conversations}, --mode {wall,unlike_pages,conversations}
The mode you want to run in. Default is `wall' which deletes wall posts
-E EMAIL, --email EMAIL
Your email address associated with the account
-P PASSWORD, --password PASSWORD
Your Facebook password
-U PROFILE_URL, --profile-url PROFILE_URL
The link to your Facebook profile, e.g. https://www.facebook.com/your.name
-F TWO_FACTOR_TOKEN, --two-factor TWO_FACTOR_TOKEN
The code generated by your 2FA device for Facebook
-H, --headless Run browser in headless mode (no gui)
--no-archive Turn off archiving (on by default)
-Y YEAR, --year YEAR The year(s) you want posts deleted.
-B CHROMEBIN, --chromebin CHROMEBIN
Optional path to the Google Chrome (or Chromium) binary
```
* Make sure that you have a recent version of Python 3.x installed (preferably
3.6 or greater)

Loading…
Cancel
Save