https://github.com/ahmadawais/ptcl-cli-bash

PTCL-CLI: An intuitive PTCL-CLI to control PTCL routers via command line.
https://github.com/ahmadawais/ptcl-cli-bash

adsl-info cli ptcl-cli reboot router

Last synced: about 1 year ago
JSON representation

PTCL-CLI: An intuitive PTCL-CLI to control PTCL routers via command line.

Host: GitHub
URL: https://github.com/ahmadawais/ptcl-cli-bash
Owner: ahmadawais
License: mit
Created: 2016-10-01T10:41:50.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2019-07-23T06:27:58.000Z (almost 7 years ago)
Last Synced: 2025-04-22T14:06:47.864Z (about 1 year ago)
Topics: adsl-info, cli, ptcl-cli, reboot, router
Language: Shell
Homepage: https://Labs.AhmadAwais.com/PTCL-CLI/
Size: 15.6 KB
Stars: 10
Watchers: 2
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

PTCL CLI

An intuitive PTCL-CLI to control PTCL routers via command line.

A FOSS (Free & Open Source Software) project. Maintained by @AhmadAwais.

# PTCL-CLI (`ptcli`)
`ptcli` is a bash CLI for PTCL routers. An intuitive PTCL-CLI to control PTCL routers via command line.

![PTCL-CLI](https://i.imgur.com/FHLLPAe.png)

You can use `ptcli` to perform following actions via command line
- Reboot the router
- Check Router's system info
- Check Router's uptime
- Check ADSL info
- Check & calculate ADSL SNR

## ⚡️ Installation

Open command line terminal (I prefer iTerm2) and run the following command.

```bash
sudo wget -qO ptcli https://git.io/vPmNx && sudo chmod +x ./ptcli && sudo install ./ptcli /usr/local/bin/ptcli
```

This command will perform the following actions:
- Use sudo permissions
- Use wget to download `PTCL-CLI` and rename it to `ptcli`
- Make the `ptcli` executable
- Install `ptcli` inside /usr/local/bin/ folder.

## 🙌 Usage
️ Usage: ptcli `[ -c |--config ]`, `[ -h | help ]`
️ - `[ -h | help ]` Use help
- `[ -c | --config ]` Use config data, if so configure the three variables 'host_address', 'username', and 'password
- `[ -r | --reboot ]` Quick reboot, dependant on '--config' param."

Here's a complimentary GIF.

![PTCL-CLI GIF](https://i.imgur.com/TzeAw5B.gif)

## 🤔 Why was PTCL CLI Created?
I am a command line junkie and it is too much work for me to go sign in and reboot the router or get the line parameters when I need to. So, I built this CLI and now with a bunch of aliases I am able to perform these actions within a single command.

## ⚡️ Environment
I have built this CLI using Mac. It needs to be run on Bash or ZSH based shell.

`Beta software! Use at your own risk.`

## ℹ️ Changelog

###1.1.0 (2017-01-31)
- UPDATE: Auto reboot routine now works
- UPDATE: Better documentation

## ℹ️ License
MIT License. Copyrights . This script has no official affiliation with PTCL.

---

### 🙌 [THEDEVCOUPLE PARTNERS](https://TheDevCouple.com/partners)

This open source project is maintained by the help of awesome businesses listed below. What? [Read more about it →](https://TheDevCouple.com/partners)