LICENSE-ME

Idea came from https://github.com/bukinoshita/license-me - thanks for that! =)

A little CLI-Program for finding ALL possible GIT repositorys on your Machine. It checks the contents of the folder for an existing "LICENSE" file, and if none is found, it will present you the directory(ies) where the file is missing.

What to expect:

This program helps you with:

• Licensing your unlicensed projects
• Creating a dummy README.md if there is none
• Updating current licenses in your projects (and change links in your readme)
• Replace existing licenses (and replace the links in your readme)

What not to expect:

• Updating the repository on GitHub (this you will have to do yourself)

How the program works

!This program needs a Internet Connection to work properly!

The Program starts with fetching all available license versions from the Github-API. When all Licenses could be fetched Properly (Yes, you can reach the API limit without a Token!)
the program starts with searching on all Drives (even your USB if plugged in!) for folders with a ".git" folder in it, and assumes that there is a valid Git-Repository.

The folder name where the .git directory is in, is assumed as "Project Title" and will be Inserted in the dummy README.md - otherwise this function will not take effect anywhere.

If the Program found a README.md in the "repository" and no "LICENSE" file, then it will create a License for you, appending the License Link to the end of the Readme file.

Also, if you wanted to append a second (or third, or fourth....) license to your Project it will create a File named like this: "LICENSE-SHORTNAME" and add a link to the end of the Readme.md that was found. If the program finds a ## LICENSE section, it will replace or extend it, depending on the mode it was executed.

If you want to replace a current license the Program will present you all directories with and without a License. You should know which repository you want to work in. It will read the README.md and searches for a "## License" section. If the Program cant find one, there will happen nothing, you have to link the License yourself.

Then it will split the README.md file into sections separated by "##" and replaces the "## License" part with a new, formatted License section. Then the README.md will be overwritten. So there SHOULD be no changes made to other parts of your README.

If the first run is done, you can choose to execute the program again, it will ask you what to do.

Configuration

The Program has now the possibility to be configurated through a JSON-config-file! The Config-file will always be in the directory where the binary is located!

If there is no File, it will create an empty file for you. If there is a file, it will load the information from it. if there is a file, and it is malformed it will delete the old and create a empty file.

The options, that can be configurated:

File Contents, when the program creates it.

{
  "github_user": "", 
  "github_api_token": null,
  "readme_template_link": "https://raw.githubusercontent.com/PurpleBooth/a-good-readme-template/main/README.md",
  "replace_in_readme_phrase": "# Project Title"
}

You can choose to modify the file directly, or let the program edit it for you.

You can use the options --github-user <USER> or --github-token <TOKEN> to set the values through the program.

If you prefer to use another readme-template put in the link where the RAW PLAIN TEXT
is reachable through the internet and replace the "prhase", that is meant for the Project title, so that the Program can replace it.

Installation

Build it yourself

Download the Sourcecode, then in the directory execute in terminal:

cargo install --path .

Install Using Cargo

cargo install --git https://github.com/frequency403/license-me.git

Download pre-built binary's

Download from the release page for your appropriate operating system.

Usage

License-me works on BOTH Windows and Unix-like operating Systems!

# Normal invocation of the Program:

#Windows:
./license-me.exe
#Unix:
./license-me

#additional flags:

#Enter your Token here, it will be saved in the settings file.
license-me --github-token <TOKEN>
#Enter your Username here, it will be saved in the settings file.
license-me --github-user <USERNAME>

## !! IMPORTANT !! Without these credentials the Program will not work!

#Debug Mode (Verbose + Additional Information)
license-me -d
#Verbose Mode (It prints out nearly everything it does)
license-me -v

#Include repos, where a license already exists, and add another to it!
license-me --append-license
#Include repos, where a license already exists, and replace it!
license-me --replace-license 
#Include all repos assumed as a git repository!
license-me --show-all 
#Include repos with a license and delete the license
license-me --unlicense

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please feel free to contact me if there is a problem with understanding the Code, or general questions about the Program.

License

MIT