{"id":13988708,"url":"https://github.com/GreatBahram/shecan-cli","last_synced_at":"2025-07-22T09:31:25.753Z","repository":{"id":44731015,"uuid":"161062261","full_name":"GreatBahram/shecan-cli","owner":"GreatBahram","description":"The Shecan CLI https://shecan.ir","archived":false,"fork":false,"pushed_at":"2025-03-19T16:19:50.000Z","size":190,"stargazers_count":25,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-04T04:08:43.438Z","etag":null,"topics":["cli","python3-6","shecan"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"afl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GreatBahram.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-09T17:07:51.000Z","updated_at":"2025-06-25T16:53:18.000Z","dependencies_parsed_at":"2025-03-19T17:25:54.092Z","dependency_job_id":"1759672d-a8c3-4039-9a8c-d86c8ea72dc0","html_url":"https://github.com/GreatBahram/shecan-cli","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/GreatBahram/shecan-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreatBahram%2Fshecan-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreatBahram%2Fshecan-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreatBahram%2Fshecan-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreatBahram%2Fshecan-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GreatBahram","download_url":"https://codeload.github.com/GreatBahram/shecan-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GreatBahram%2Fshecan-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266465076,"owners_count":23933057,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","python3-6","shecan"],"created_at":"2024-08-09T13:01:19.203Z","updated_at":"2025-07-22T09:31:25.732Z","avatar_url":"https://github.com/GreatBahram.png","language":"Python","readme":"# Shecan CLI\n\n[![image](https://img.shields.io/pypi/v/shecan.svg)](https://pypi.org/project/shecan/)\n[![image](https://img.shields.io/pypi/l/shecan.svg)](https://pypi.org/project/shecan/)\n[![image](https://img.shields.io/pypi/pyversions/shecan.svg)](https://pypi.org/project/shecan/)\n[![image](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/GreatBahram)\n\n------------------------------------------------------------------------\n\nThe Shecan CLI is used to configure your DNS name server based on Shecan website from the command line.\n\nFor more about Shecan see https://shecan.ir/\n\n* 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.\n\n## Introduction\n\n![How to use shecan?](./shecan.svg)\n\n## Installation\n\nInstall via one of these methods:\n\nwith pip:\n```shell\npython3 -m venv .venv\nsource .venv/bin/activate\npip install shecan\n```\nOr with [pipx](https://pipx.pypa.io/stable/):\n```shell\npipx install shecan\n```\nor with [uv](https://docs.astral.sh/uv/guides/tools/):\n```shell\nuv tool install shecan\n```\n## Quickstart\n\n* Run ``shecan update`` - It will get Shecan DNS name servers and save them into a configuration file.\n* Run ``shecan list`` It will show shecan DNS name servers from the configuration file.\n* 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`.\n* Run ``shecan verify`` It will check your DNS configuration and make sure that shecan works fine for you.\n* Run ``shecan restore`` It will restore your previous DNS configuration.\n* Run ``shecan show`` It will print your current DNS configuration.\n* Run ``shecan --version`` It will show shecan's version.\n* Run ``shecan --help`` It will show full command-line options and subcommands.\n\n## Contributing\nTo contribute to this tool, first checkout the code. Then create a new virtual environment:\n```shell\ncd shecan-cli\npython -m venv .venv\nsource .venv/bin/activate\n```\nNow install the dependencies and test dependencies:\n```shell\npip install -e '.[dev]'\n```\nOr if you are using [uv](https://docs.astral.sh/uv/):\n```shell\nuv sync\n```\nInstall pre-commit hooks to ensure code quality:\n```shell\npre-commit install\npre-commit install -t pre-push\n```\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGreatBahram%2Fshecan-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGreatBahram%2Fshecan-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGreatBahram%2Fshecan-cli/lists"}