hackCLIMap

check out the GitHub - check out on npm (package manager)

showcases

compatibility

this project works and can be installed on any device running nodeJS, that being mostly Linux, Windows, and macOS, but it can be installed on Android with terminal emulators for example!

compatibility with devices running anything else than macOS, Linux, or Windows has been untested and is gonna be random.

features

this project allows you to do exactly the same stuff you would do on the Hack Club mail portal (mail.hackclub.com), but via your terminal! you can:

list your packages, letters,
check a certain letter's information (or package),
view the global earth map of letters (without lag compared to the web version!!),
and you can also view your legacy shipments if you have any associated to your account, but I'm not sure anyone even has any of these.

api endpoints

to use this project, you must first get an API key for hack club mail over here. once you'll first initiate the project, it'll ask you for your API key, and store it in your home directory under the file '.hackCLIMap-apikey.json'. you can edit or reset your API key there!

the hack club mail API is not very well documented, and since it's not very clear on how to use it i'll put the list of endpoints used here, so you may understand better! here's a list of known routes:

/api/public/v1/me
/api/public/v1/mail (the important one)
/api/public/v1/letters
/api/public/v1/letters/:id
/api/public/v1/packages
/api/public/v1/packages/:id
/api/public/v1/lsv
/api/public/v1/lsv/:type/:id

quick installation with npm

      npm install -g hackclimap
      hackclimap
      > should start

you're good to go!

manual installation from source

      git clone https://github.com/Lolo280374/hackCLIMap.git
      cd hackCLIMap
      npm install
      npm link
      hackclimap
      > should start

you're good to go! you can now get editing, or anything else you wanted to do from source!

reporting issues

this is a community project, and your help is very much appreciated! if you notice anything wrong durign your usage of this project, please report it on the GitHub issues tracker!

privacy statement

this tool dosen't contain any analytics, or software that does connection to third party or online services, excluding the hack club mail API. you can check the source code if you have any doubts, but no analytics are being obtained thru this software!

license

this project is licensed under the MIT license. you can check it here.

if you have any questions about this project, please reach me at lolodotzip@proton.me