# ir-router 
ir-router is a python made program for macos linux and windows installed via Pip 

# what is ir-router
most iranians have problems switching from vpn to vpn 
ir-router adds a cli to connect to any configuration if you have the plugin to do it 

# How to buid a sub

subs are ir-routers system to store vpn configs 

example

```json
{
    "local": {
        "name_of_config": {
            "protocol": "vpn_protocal",
            "config": "path_to_config"
          }
      },
    "remote": {}
}
```

remote is not yet implemented

# how to build a plugin

plugins are the way ir-router connects to vpns 

example

```json
{
    "openvpn": {
        "about": "OpenVPN client",
        "exec_command": "sudo openvpn"
    }
}
```

# notes 

No Plugins are implemented from the start
this is bare minimum 0.1alpha

All configs are stored in HOME/.ir-router

HOME means your os es home dir 

"Built in iran with Love"
