Griefficient

A command line tool that scans Shodan for Minecraft servers and shows you details about them.

Installation and usage

Using the executable (recommended)

1. Get the latest executable for your platform from the "Releases" section on GitHub.
2. Set up your environment variables.
3. Run the executable.

Using npm

1. Install Node.js.
2. Run npm i -g griefficient in a terminal. (On Linux you might need root privileges.)
3. Set up your environment variables.
4. Run griefficient in a new terminal.

By compiling

1. Install Git, Node.js and pnpm.
2. Open a terminal and run:

git clone https://github.com/Odyssey346/Griefficient
cd Griefficient
pnpm i
pnpm build

3. Set up your environment variables.
4. Run pnpm preview in the same terminal you ran the previous commands.

---

Environment Variables

You need to set the GRIEFFICIENT_API_KEY environment variable to your Shodan API key.

Guide for Windows

Guide for Linux

---

Credits

• Odyssey346 - Main developer
• akisblack - Made the building and development process easier