PomCli

A pom.xml CLI parser for your GitHub repos.

A Command Line Interface application that uses GitHub app capabilities to search and parse the pom.xml files in the user's repositories. Parsed results show the dependencies in that pom file.

Setup

1. Create a GitHub app with scopes from repository read access and user info.
2. Put the client id & secret as in the .sample.env file and rename it to .env

Run with global python installation

• Install the required dependencies

pip install -r requirements.txt

• Run the CLI with the following command.

# Linux/macOS
python3 ./run.py 

Run within enivronment

• Create and activate environment pom_cli

# Linux/macOS
python3 -m venv pom_cli
source ./pom_cli/bin/activate

• Run the CLI with the following command.

python ./run.py

(Bonus) Run as an executable

• (Optional) If you want to use the program as an executable, run the executable.sh file, make sure to replace the path there!

Commands

• login: The login command, logs the user via the github device code OAuth service.

• listRepos: The listRepos command, lists all the repositories of the currently logged in user.

• selectRepo: The selectRepo command, selects one of the repositories to search for pom.xml files in it.

• searchPom: The searchPom command, searches and lists all the pom.xml files in the currently selected repository.

• listPomDep: The listPomDep command, lists all the dependencies of the currently selected pom.xml file in the currently selected repository.

• clear: Clears the terminal
• ..: Goes to previous level command.

• logout: Logs out the current user and exits from the CLI.

• exit: Exit from the PomCli.

Future Ideas

• Add refresh token logic to the login function.
• Fix the help function.
• Print the selected pom.xml file.

---

Made with ❤️ by