riyaa-01 / hacktoberfest-repo-topic-apply

Cmd line tool to add a topic to your github repo, defaults to hacktoberfest

hfest-repo command line tool

hfest is a tool that adds the hacktoberfest topic to every public repository associated with a user or a GitHub org. It can also create the invalid, spam and hacktoberfest-accepted labels in your repos.

Installation

1. Download the latest release from the releases page.
2. Either move the binary to /usr/local/bin or run it locally.

Create a GitHub Token

You will need a GitHub token to perform these actions on your repositories. Follow the instructions for creating a personal access token and be sure to give it repo access.

Usage

To use hfest-repo, run:

hfest-repo -t <GITHUB_TOKEN> 

If you don't specify your GitHub token, the tool will look for an environment variable named GITHUB_ACCESS_TOKEN.

The "Default Hacktoberfest run this on my stuff" command

hfest-repo -t <GITHUB_TOKEN> -u <GITHUB_USER> --labels

The "Default Hacktoberfest run this on my stuff" command, but run as a dry run for validation

hfest-repo -t <GITHUB_TOKEN> -u <GITHUB_USER> --labels --dry-run

Add Hacktoberfest topic to a user's repos

hfest-repo -t <GITHUB_TOKEN> -u <GITHUB_USER>

Add Hacktoberfest topic to an organization's repos

hfest-repo -t <GITHUB_TOKEN> -o <GITHUB_ORG>

Add Hacktoberfest topic to a user's repos and add labels

hfest-repo -t <GITHUB_TOKEN> -u <GITHUB_USER> --labels

Add Hacktoberfest topic to an organization's repos and add labels

hfest-repo -t <GITHUB_TOKEN> -o <GITHUB_ORG> --labels

Remove Hacktoberfest topic from a user/org

hfest-repo -t <GITHUB_TOKEN> -u <GITHUB_USER>/-o <GITHUB_ORG> --remove

Add an arbitrary topic to a user's/organization's repos instead of the hacktoberfest topic

hfest-repo -t <GITHUB_TOKEN> -u <GITHUB_USER>/-o <GITHUB_ORG> -p fun

Add Hacktoberfest topic to a user's repos including private and forks

hfest-repo -t <GITHUB_TOKEN> -u <GITHUB_USER> --include-forkes --include-private

Supported Options

usage: hfest-repo [<flags>]

Flags:
      --help                   Show context-sensitive help (also try --help-long and --help-man).
  -t, --access-token=ACCESS-TOKEN  
                               GitHub API Token - if unset, attempts to use this tool's stored token of its current default context. env var: GITHUB_ACCESS_TOKEN
  -u, --gh-user=GH-USER        github user to fetch repos of
  -o, --gh-org=GH-ORG          github org to fetch repos of
  -p, --topic="hacktoberfest"  topic to add to repos
  -r, --remove                 Remove hacktoberfest topic from all repos
  -l, --labels                 Add spam, invalid, and hacktoberfest-accepted labels to repo
      --include-forks          Include forks
      --include-private        Include private repos
  -d, --dry-run                Show more or less what will be done without doing anything