Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alvarocastro/wow-realm-status-cli
Simple console utility to check the status and info of World of Warcraft realms.
https://github.com/alvarocastro/wow-realm-status-cli
battlenet blizzard cli realm world-of-warcraft wow
Last synced: about 1 month ago
JSON representation
Simple console utility to check the status and info of World of Warcraft realms.
- Host: GitHub
- URL: https://github.com/alvarocastro/wow-realm-status-cli
- Owner: alvarocastro
- License: mit
- Created: 2019-09-11T16:17:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-16T20:02:02.000Z (almost 2 years ago)
- Last Synced: 2024-11-18T23:19:45.939Z (about 2 months ago)
- Topics: battlenet, blizzard, cli, realm, world-of-warcraft, wow
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/wow-realm-status-cli
- Size: 751 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wow-realm-status-cli
[](https://www.npmjs.com/package/wow-realm-status-cli)
[](https://codeclimate.com/github/alvarocastro/wow-realm-status-cli/maintainability)
[](https://github.com/xojs/xo)
Simple console utility to check the status and info of World of Warcraft realms.
- [Install](#install)
- [Usage](#usage)
- [Contributing](#contributing)
- [Support](#support)
- [Related](#related)
## Install
```bash
npm install -g wow-realm-status-cli
```
## Usage
```bash
$ wow-realm-status us ragnaros
Name: Ragnaros
Status: online
Population: full
Type: normal
Locale: es-MX
Timezone: CDT
```
### wow-realm-status [options] \ \
#### region
The region of the realm you want to fetch.
Possible values are: `us`, `eu`, `kr`, `tw`
#### realm
The name of the realm.
#### Options
##### -c, --classic
Used to specify if it is a classic realm, to prevent name clashing.
```bash
$ wow-realm-status us kirtonos -c
Name: Kirtonos
Status: online
Population: medium
Type: pvp
Locale: en-US
Timezone: EDT
```
##### -bc, --burningcrusade
Used to specify if it is a Burning Crusade classic realm, to prevent name clashing.
```bash
$ wow-realm-status us earthfury -bc
Name: Earthfury
Status: online
Population: high
Type: pvp
Locale: en-US
Timezone: EDT
```
##### -f, --filter
Used to filter the output fields.
Possible values: `name`, `status`, `population`, `type`, `locale`, `timezone`
```bash
$ wow-realm-status us ragnaros -f name,status,population
Name: Ragnaros
Status: online
Population: full
```
##### -s, --simple
Used to simplify the output and hide the loading spinner.
##### -j, --json
Used to format the output as JSON
```bash
$ wow-realm-status us ragnaros -j
{"name":"Ragnaros","locale":"es-MX","timezone":"CDT","status":"online","type":"normal","population":"full"}
```
##### -v, --version
Displays the current installed version of this utility.
##### -h, --help
Displays the help.
## Contributing
Contributions are always welcome! Please run `npm test` before hand to ensure everything is ok.
## Support
If you use this package please consider starring it :)
## Related
* [wow-realm-status](https://github.com/alvarocastro/wow-realm-status) - Node.js library used to retrieve the realm status.