emberkom/dnshelper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor: Rename project from dns-helper to ekdns across all files and documentation

Browse Source
This commit is contained in:
dyoder
2026-03-04 17:03:30 -05:00
parent 03cbe1bb00
commit 3550193e63
25 changed files with 107 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/agents/copilot-instructions.md
+18 -18
View File
@@ -1,8 +1,8 @@
# dns-helper Development Guidelines
# ekdns Development Guidelines
## Project Overview
dns-helper — a Go CLI tool that resolves hostnames against a specified DNS server and writes the resulting IP-to-hostname mappings into the local hosts file. It manages a clearly delimited block within the hosts file so it can cleanly add and remove only its own entries. Built as a single static binary with no runtime dependencies.
ekdns — a Go CLI tool that resolves hostnames against a specified DNS server and writes the resulting IP-to-hostname mappings into the local hosts file. It manages a clearly delimited block within the hosts file so it can cleanly add and remove only its own entries. Built as a single static binary with no runtime dependencies.
## Go Toolchain — CRITICAL
@@ -48,32 +48,32 @@ go test ./... # May use incompatible Go version
.\build.ps1 -Release -Package
```
Output: `build\dns-helper.exe` (default), `build\dns-helper-<os>-<arch>[.exe]` (cross-compile).
Release packages: `releases\dns-helper-<version>-<os>-<arch>.zip` / `.tar.gz`
Output: `build\ekdns.exe` (default), `build\ekdns-<os>-<arch>[.exe]` (cross-compile).
Release packages: `releases\ekdns-<version>-<os>-<arch>.zip` / `.tar.gz`
## Running dns-helper
## Running ekdns
dns-helper has two commands: `add` and `delete` (with short aliases `a` and `d`/`del`).
ekdns has two commands: `add` and `delete` (with short aliases `a` and `d`/`del`).
```powershell
# Add one or more hostnames (resolves via the given DNS server, writes to hosts file)
.\build\dns-helper.exe add -host hostname.example.com -server dns.example.com
.\build\dns-helper.exe a -host hostname.example.com -server dns.example.com
.\build\ekdns.exe add -host hostname.example.com -server dns.example.com
.\build\ekdns.exe a -host hostname.example.com -server dns.example.com
# Add multiple hostnames at once (comma-separated)
.\build\dns-helper.exe add -host "host1.example.com,host2.example.com" -server dns.example.com
.\build\ekdns.exe add -host "host1.example.com,host2.example.com" -server dns.example.com
# Delete a specific hostname from the managed block
.\build\dns-helper.exe delete -host hostname.example.com
.\build\dns-helper.exe del -host hostname.example.com
.\build\dns-helper.exe d -host hostname.example.com
.\build\ekdns.exe delete -host hostname.example.com
.\build\ekdns.exe del -host hostname.example.com
.\build\ekdns.exe d -host hostname.example.com
# Delete multiple hostnames (comma-separated)
.\build\dns-helper.exe delete -host "host1.example.com,host2.example.com"
.\build\ekdns.exe delete -host "host1.example.com,host2.example.com"
# Delete ALL entries added by dns-helper
.\build\dns-helper.exe delete all
.\build\dns-helper.exe delete a
# Delete ALL entries added by ekdns
.\build\ekdns.exe delete all
.\build\ekdns.exe delete a
```
### Flag Reference
@@ -83,7 +83,7 @@ dns-helper has two commands: `add` and `delete` (with short aliases `a` and `d`/
| `add` | `-host` | Yes | Comma-separated list of hostnames to resolve and add |
| `add` | `-server` | Yes | DNS resolver to query (e.g. `dns.example.com`) |
| `delete` | `-host` | Yes (unless `all`) | Comma-separated list of hostnames to remove |
| `delete all` | — | — | Removes every entry dns-helper has written |
| `delete all` | — | — | Removes every entry ekdns has written |
### Exit Codes
@@ -94,7 +94,7 @@ dns-helper has two commands: `add` and `delete` (with short aliases `a` and `d`/
### Hosts File Management
dns-helper wraps its entries between two marker lines:
ekdns wraps its entries between two marker lines:
```
# DNSHelper <<-> START CONFIG