steam-api-cli v2.1.0

• Requirements
• Usage
• Commands
• Updates

Requirements

To use steam-api-cli you will need to have the following:

• A Steam API Key
• A SteamID
• The appID

Usage

$ npm install -g steam-api-cli
$ steam COMMAND
running command...
$ steam (-v|--version|version)
steam-api-cli/2.1.0 win32-x64 node-v14.16.1
$ steam --help [COMMAND]
USAGE
  $ steam COMMAND
...

Commands

• steam games:launch [APPID]
• steam games:list [STEAMID]
• steam help [COMMAND]
• steam user
• steam user:all
• steam user:inv

steam games:launch [APPID]

Launches steam games

USAGE
  $ steam games:launch [APPID]

ARGUMENTS
  APPID  appID

OPTIONS
  -d, --default  Use this to use or set default appid. Shared across all commands

EXAMPLES

  $ steam games:launch
  $ steam games:launch -d
  $ steam games:launch 2915500

See code: src/commands/games/launch.js

steam games:list [STEAMID]

Lists games owned on a Steam account

USAGE
  $ steam games:list [STEAMID]

ARGUMENTS
  STEAMID  steamID

OPTIONS
  -d, --default  Use this to use or set

EXAMPLES

  $ steam games:list
  $ steam games:list -d
  $ steam games:list 76561198378367745

See code: src/commands/games/list.js

steam help [COMMAND]

display help for steam

USAGE
  $ steam help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

steam user

Grabs your Steam profile data

USAGE
  $ steam user

OPTIONS
  -d, --default    Use this to set the given user as the default
  -k, --key=key    Change the current Steam API Key
  -u, --user=user  Change the default steamID setting

EXAMPLES

  $ steam user
  $ steam user -d
  $ steam user -d -u 76561198378367745

See code: src/commands/user/index.js

steam user:all

Grabs items and info about a user

USAGE
  $ steam user:all

OPTIONS
  -c, --context=context  Changes the default context id setting
  -d, --default          Use this to set the given user as the default
  -g, --game=game        Change the default game setting
  -k, --key=key          Change the current Steam API Key
  -t, --trade=trade      Change the default show-tradable-item setting
  -u, --user=user        Change the default steamID setting

EXAMPLES

  $ steam user:all
  $ steam user:all -d
  $ steam user:all -d -t true -c 6

See code: src/commands/user/all.js

steam user:inv

Grab items from a Steam Inventory

USAGE
  $ steam user:inv

OPTIONS
  -c, --context=context  Changes the default context id setting
  -d, --default          Use this to set the given user as the default
  -g, --game=game        Change the default game setting
  -k, --key=key          Change the current Steam API Key
  -t, --trade=trade      Change the default show-tradable-item setting
  -u, --user=user        Change the default steamID setting

EXAMPLES

  $ steam user:inv
  $ steam user:inv -d
  $ steam user:inv -d --game 440

See code: src/commands/user/inv.js

Updates

This current version of steam-api-cli is a first launch
and all features have not been implemented yet but are in progress

Future

• Retrieve info of Steam user
• View owned games
• Launch games

Change Log

* 2.1.0 New command + clean up + restructure
* 2.0.1 Readme bug fixes
* 2.0.0 Rewrite of program + new `user` command
* 1.2.1 Readme bug fixes
* 1.2.0 Code clean up + new error handling  
* 1.1.1 Error handling + Info update
* 1.1.0 Pricing available
* 1.0.0 Inital Release

Contribution

Everyone is absolutly welcome to contribute to this project
Just fork it, make changes and create a PR and I'll check it out

License

MIT License

Copyright (c) 2021 ItzAfroBoy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.