Get all details related to your steam account be it normal user stats, list of games owned, achievements in a game, etc on your terminal window with a single 2 word command instead of going to different tabs on the steam website or desktop app.
Tools and packages required to successfully install this project.
- node.js : Install
- Steam API Key : Get
- User ID (can be obtained by clicking your username on the steam site and -> view profile, copy the the last section of the URL)
eg : id from https://steamcommunity.com/profiles/id/
A step by step list of commands / guide that informs how to install an instance of this project.
For Windows
git clone https://github.com/ishaan5199/steam-boy.git
cd steam-boy
npm i
If you want to use the application globally from any directory
npm install -g
Navigate to package.json file and place your steam API key and User ID as a value for "apiKey" and "steamID" in quotes respectively.
If either of steam API key or the User ID is invalid, the app will throw an error.
Basic format
>sb <command> [option] //or if not installed globally : node index.js <command> [option] this will not work outside the steam-boy directory
- Looking up the different commands available using
help
command.
>sb help
- No extra command
>sb
- Get the list of games owned by you by using
games
command.
>sb games
- Get the list of achievements in a game using
ach
command and an optional flag-i
by providing the game ID, if not provided, it will show achievements from the most played game
>sb ach -i [id]
Ishaan Mahesh
You can find me here at: LinkedIn