Skip to content

Slowline/faceit-cli

Repository files navigation

FACEIT CLI Tool

A command-line interface tool for fetching and analyzing FACEIT player data.

Features

  • View player history
  • Compare player statistics
  • Search for players
  • Cache player statistics

Installation

From Source

  1. Clone the repository:
git clone https://github.com/Slowline/faceit-cli.git
cd face
  1. Install dependencies:
npm install
  1. Build the project:
npm run build
  1. Run the CLI:
npm start

As a Single Executable

  1. Install dependencies:
npm install
  1. Create the single executable:
npm run package

This will create executables in the dist/executables directory for Windows, Linux, and macOS.

Usage

View Player History

faceit-cli history <playerIdentifier> [options]

Compare Players

faceit-cli compare <player1Identifier> <player2Identifier> [options]

Search for Players

faceit-cli search <query> [options]

Cache Player Statistics

faceit-cli stats <playerIdentifier> [options]

Options

  • -g, --game <game>: Specify the game (cs2 or csgo, default: cs2)

Development

  1. Install dependencies:
npm install
  1. Run in development mode:
npm run dev

Building Single Executables

The project is set up to create single executables using pkg, which packages Node.js applications into standalone executables.

To build the executables:

npm run package

This will create executables for Windows, Linux, and macOS in the dist/executables directory.

License

GNU GPLv3

About

A command-line interface tool for fetching and analyzing FACEIT player data.

Resources

License

Stars

Watchers

Forks

Packages

No packages published