Singular Solution

Keep your Twitter follower count at zero by blocking and then quickly unblocking any new followers.

Available as a binary and Docker container.

Usage

Singular Solution needs an API key and secret as well as an OAuth access token and access secret.

If you only have an API key and secret and need an access token and secret the auth subcommand (documented below) can help you obtain one.

If you need an API key and secret then Google around and you should be able to find those which are used by the official Twitter clients. It is no longer feasible to register your own application since the API endpoints needed cost a ridiculous amount of money.

From there, you can run Singular Solution in one of two ways:

• Command line
• Docker

Command-line

Install on Mac OS with:

$ brew install JakeWharton/repo/singular-solution

For other platforms, download ZIP from latest release and run bin/singular-solution or bin/singular-solution.bat.

$ singular-solution --help
Usage: singular-solution [<options>] <command> [<args>]...

Options:
  -h, --help  Show this message and exit

Commands:
  auth  Perform interactive authentication to get an access token and secret
  run   Block and quickly unblock all followers to keep count at zero

$ singular-solution auth -h
Usage: singular-solution auth [<options>]

  Perform interactive authentication to get an access token and secret

Options:
  --api-key=<key>     OAuth consumer API key
  --api-secret=<key>  OAuth consumer API secret
  -h, --help          Show this message and exit

$ singular-solution run -h
Usage: singular-solution run [<options>]

  Block and quickly unblock all followers to keep count at zero

Options:
  --access-token=<key>   OAuth access token
  --access-secret=<key>  OAuth access token secret
  --api-key=<key>        OAuth consumer API key
  --api-secret=<key>     OAuth consumer API secret
  --dry-run              Print destructive actions instead of performing them
  -h, --help             Show this message and exit

Docker

A container with the binary is available from Docker Hub and GitHub Container Registry.

• jakewharton/singular-solution
• ghcr.io/jakewharton/singular-solution

The trunk branch pushes to the trunk tag on both registries, or you can use a tagged version.

The container automatically triggers the binary using cron.

$ docker run -it --rm
    -e "CRON=*/3 * * * *" \
    -e "ACCESS_TOKEN=..." \
    -e "ACCESS_SECRET=..." \
    -e "API_KEY=..." \
    -e "API_SECRET=..." \
    jakewharton/singular-solution:trunk

To be notified when the binary is failing visit https://healthchecks.io, create a check, and specify the ID to the container using the HEALTHCHECK_ID environment variable.

Docker Compose

version: '2'
services:
  singular-solution:
    image: jakewharton/singular-solution:trunk
    restart: unless-stopped
    environment:
      - "CRON=*/3 * * * *"
      - "ACCESS_TOKEN=..."
      - "ACCESS_SECRET=..."
      - "API_KEY=..."
      - "API_SECRET=..."
      #Optional:
      - "HEALTHCHECK_ID=..."

Development

To run the latest code build with ./gradlew installDist. This will put the application into build/install/singular-solution/. From there you can use the command-line instructions instructions to run.

The Docker containers can be built with docker build ., which also runs the full set of checks as CI would.

License

Copyright 2022 Jake Wharton

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.