https://github.com/ramadani/adminarea-cli
Administrative Area Command Line Interface (CLI)
https://github.com/ramadani/adminarea-cli
administrative-areas cities cli command-line-tool countries districts golang golang-cli golang-library indonesia provinces villages
Last synced: 3 months ago
JSON representation
Administrative Area Command Line Interface (CLI)
- Host: GitHub
- URL: https://github.com/ramadani/adminarea-cli
- Owner: ramadani
- License: mit
- Created: 2018-10-17T08:23:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-25T09:37:10.000Z (over 6 years ago)
- Last Synced: 2025-02-06T10:53:23.639Z (5 months ago)
- Topics: administrative-areas, cities, cli, command-line-tool, countries, districts, golang, golang-cli, golang-library, indonesia, provinces, villages
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# adminarea-cli
Administrative Area CLI
## Features
* Create db table
* Save a country
* Save the provinces of a country
* Save the cities/regencies of a country
* Save the districts of a country
* Save the villages of a country
### Available Countries
- Indonesia (id)
## Installation
To install the library and command line program, use the following:
```bash
go get -v github.com/ramadani/adminarea-cli/...
```
## Usage
Create `adminarea_config.yml` and fill it with following this values:
```yaml
db:
driver: mysql
dsn: user:password@tcp(127.0.0.1:3306)/dbname?parseTime=true
```
### Available Commands
```cmd
setup Create administrative areas table
country Save a country province Save the provinces of a country
city Save the cities/regencies of a country
district Save the districts of a country
village Save the villages of a country
```
### Create DB table
To create `administrative_areas` table to your database, run this command:
```cmd
adminarea-cli setup
```
### Save the country
```cmd
// adminarea-cli country [COUNTRY_CODE_ID]
adminarea-cli country id
```
### Save the provinces of a country
```cmd
// adminarea-cli province [COUNTRY_CODE_ID]
adminarea-cli province id
```
### Save the cities/regencies of a country
```cmd
// adminarea-cli city [COUNTRY_CODE_ID]
adminarea-cli city id
```
### Save the districts of a country
```cmd
// adminarea-cli district [COUNTRY_CODE_ID]
adminarea-cli district id
```
### Save the villages of a country
```cmd
// adminarea-cli village [COUNTRY_CODE_ID]
adminarea-cli village id
```
## TODO
- [x] Can create db table
- [ ] Config file can pass by argument
- [x] Save a country
- [x] Save provinces by country
- [x] Save regencies by country
- [x] Save districts by country
- [x] Save villages by country
## References
* [edwardsamuel/Wilayah-Administratif-Indonesia](https://github.com/edwardsamuel/Wilayah-Administratif-Indonesia)
* [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm)
## License
This library is distributed under the [MIT](LICENSE) license.