https://github.com/mykeels/spectranet-cli
A CLI tool for retrieving and presenting spectranet user account data in a readable format 😍
https://github.com/mykeels/spectranet-cli
cli node spectranet
Last synced: 10 months ago
JSON representation
A CLI tool for retrieving and presenting spectranet user account data in a readable format 😍
- Host: GitHub
- URL: https://github.com/mykeels/spectranet-cli
- Owner: mykeels
- Created: 2018-09-26T23:45:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-11T00:22:23.000Z (over 3 years ago)
- Last Synced: 2025-05-30T11:47:39.979Z (about 1 year ago)
- Topics: cli, node, spectranet
- Language: JavaScript
- Homepage:
- Size: 64.5 KB
- Stars: 40
- Watchers: 1
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spectranet CLI
This is an unofficial CLI tool for accessing Spectranet user account data from its web portal.
## Installation
```sh
yarn global add spectranet-cli
```
or
```sh
npm i -g spectranet-cli
```
## Dependencies
- You will need to have Google Chrome installed to use this. This program should automatically detect the file path to your Chrome executable, however you can override it by specifying the `CHROME_EXECUTABLE_PATH` env variable. e.g. `CHROME_EXECUTABLE_PATH="/path/to/chrome" spectranet-cli`
## Usage as NPM Module
```js
const spectranet = require('spectranet-cli')
spectranet.info().then(info => {
console.log('my basic spectranet info', info)
})
spectranet.payments().then(payments => {
console.log('my spectranet payments', payments)
})
spectranet.usage().then(records => {
console.log('my usage history', records)
})
spectranet.speed().then(speed => {
console.log('my network speed', speed)
})
```
You can specify `username` and `password` either by setting the `SPECTRANET_USERNAME` and `SPECTRANET_PASSWORD` env variables respectively, or by using the `spectranet.config({ username, password })` method.
## Usage as CLI Tool
- Get Basic Info
```bash
spectranet-cli
-s, --save save login details
-l, --logout delete previously saved login details
```
- Get Payments Info
```bash
spectranet-cli payments
-f, --first view oldest payment info
-l, --last view most recent payment info
```
To get first 3 payments, use `spectranet-cli payments -f 3` or `spectranet-cli payments --first 3`
- Get Data Usage Info
```bash
spectranet-cli usage
-f, --from from date in DD-MM-YYYY format
-t, --to to date in DD-MM-YYYY format
```
To specify the starting/from date as `26-09-2018`, use
```bash
spectranet-cli usage -f 26-09-2018
```
or
```bash
spectranet-cli usage --from 26-09-2018
```
- Get Internet Speed Info
```bash
spectranet-cli speed
```