LEADR CLI¶
Command-line tool for managing your LEADR account and leaderboards.
Need help? Give us a shout on Discord: discord.gg/RMUukcAxSZ
What is LEADR?¶
LEADR is the cross-platform leaderboard backend for game developers. The LEADR CLI provides a command-line interface to manage your account, games, leaderboards, and scores.
Quick Links¶
- Getting Started - Installation and first steps
- Authentication - How to configure your API key
- Command Reference - Full command documentation
Quick Start¶
curl -sSL https://raw.githubusercontent.com/LEADR-official/leadr-cli-releases/main/install.sh | bash
leadr register
See Getting Started for more details.
Features¶
- Account Management - Create and manage your LEADR account
- Game Management - Register and configure your games
- Leaderboard Management - Create and customize leaderboards
- Score Management - Submit and query scores
- Anti-Cheat - Review flagged scores and manage devices
Common Commands¶
| Command | Description |
|---|---|
leadr register |
Create a new LEADR account |
leadr auth admin configure |
Configure your API key |
leadr game create |
Create a new game |
leadr game list |
List your games |
leadr board create |
Create a leaderboard |
leadr board list |
List boards for a game |
leadr score list |
List scores on a leaderboard |
leadr --help |
Show all available commands |
leadr <command> --help |
Show help for a specific command |
Command Groups¶
| Group | Description |
|---|---|
| auth | Authentication and API key management |
| account | Account management |
| user | User management |
| api-key | API key management |
| game | Game management |
| board | Leaderboard management |
| board-template | Recurring leaderboard templates |
| score | Score management |
| device | Device management |
| device-session | Device session management |
| score-flag | Anti-cheat score flags |
| score-submission-meta | Score submission analytics |
Documentation¶
For full documentation, visit docs.leadr.gg