https://github.com/GreatBahram/shecan-cli

The Shecan CLI https://shecan.ir
https://github.com/GreatBahram/shecan-cli

cli python3-6 shecan

Last synced: 3 months ago
JSON representation

The Shecan CLI https://shecan.ir

• Host: GitHub
• URL: https://github.com/GreatBahram/shecan-cli
• Owner: GreatBahram
• License: afl-3.0
• Created: 2018-12-09T17:07:51.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-07-06T21:21:38.000Z (over 2 years ago)
• Last Synced: 2024-08-02T23:18:16.061Z (3 months ago)
• Topics: cli, python3-6, shecan
• Language: Python
• Homepage:
• Size: 135 KB
• Stars: 21
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shecan CLI

[![image](https://img.shields.io/pypi/v/shecan.svg)](https://pypi.org/project/shecan/)

[![image](https://img.shields.io/pypi/l/shecan.svg)](https://pypi.org/project/shecan/)

[![image](https://img.shields.io/pypi/pyversions/shecan.svg)](https://pypi.org/project/shecan/)

[![image](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/GreatBahram)

------------------------------------------------------------------------

The Shecan CLI is used to configure your DNS name server based on Shecan website from the command line.

For more about Shecan see https://shecan.ir/

* I wrote this script, because I wanted to configure a couple of linux servers to be able to use docker hub, which are blocked in Iran. And I wanted to get an agent to do it.

## Introduction

![How to use shecan?](./shecan.svg)

## Installation

The following instructions will place the shecan executable in a

virtualenv under `shecan/bin/shecan`.

- Shecan **requires** `>= Python 3.6.1`

### pip

This installs the latest stable, released version.

```

$ python3.6 -m venv shecan

$ shecan/bin/pip install shecan

```

# Quickstart

* Run ``shecan update`` - It will get Shecan DNS name servers and save them into a configuration file.

* Run ``shecan list`` It will show shecan DNS name servers from the configuration file.

* Run ``shecan set `` This will change your DNS temporarily by moving your current `/etc/resolv.conf` file and replace it with shecan DNS name server. **If you encounter permission problem** run the command this way: `sudo $(which shecan) set`.

* Run ``shecan verify`` It will check your DNS configuration and make sure that shecan works fine for you.

* Run ``shecan restore`` It will restore your previous DNS configuration.

* Run ``shecan show`` It will print your current DNS configuration.

* Run ``shecan --version`` It will show shecan's version.

* Run ``shecan --help`` It will show full command-line options and subcommands.