sam/awl: A command-line DNS lookup tool that supports DNS queries over UDP, TCP, TLS, HTTPS, DNSCrypt, and QUIC.

sam/awl

A command-line DNS lookup tool that supports DNS queries over UDP, TCP, TLS, HTTPS, DNSCrypt, and QUIC. https://dns.froth.zone/awl/

Find a file

Sam Therapy 58cee5b3c9 All checks were successful Mirror Push / mirror (push) Successful in 6s Details Test / test (stable) (push) Successful in 39s Details Test / test (oldstable) (push) Successful in 56s Details docs: Add more documentation Add the "official" logo. Also run golangci-lint Signed-off-by: Sam Therapy <sam@samtherapy.net>		2024-03-23 22:00:01 +01:00
.forgejo/workflows	ci: Improve all actions	2024-03-16 23:26:02 +01:00
.github	ci: Improve all actions	2024-03-16 23:26:02 +01:00
cmd	docs: Add more documentation	2024-03-23 22:00:01 +01:00
completions	feat: Trace (#162 )	2022-12-10 17:51:49 +00:00
conf	feat: change import URL	2023-02-17 19:18:58 +01:00
coverage	(refactor) Draw the rest of the owl (#38 )	2022-07-26 00:32:31 +00:00
doc	docs: Add more documentation	2024-03-23 22:00:01 +01:00
pkg	docs: Add more documentation	2024-03-23 22:00:01 +01:00
snap	docs: Add more documentation	2024-03-23 22:00:01 +01:00
.editorconfig	refactor: Make tests less ugly (#102 )	2022-09-21 23:08:31 +00:00
.gitignore	fix(goreleaser): stop using universal binaries	2023-02-20 20:35:52 +01:00
.gitmodules	Remove AUR submodule	2022-09-27 15:36:34 +00:00
.golangci.yaml	feat: more API work	2022-09-15 11:02:43 +00:00
.goreleaser.yaml	fix(AAAA): AAAAA	2024-03-15 18:42:29 +01:00
CODE_OF_CONDUCT.md	docs: Add more documentation	2024-03-23 22:00:01 +01:00
CONTRIBUTING.md	docs: Add more documentation	2024-03-23 22:00:01 +01:00
docs.go	(feat)Completions and documentation (#78 )	2022-09-04 23:28:47 +00:00
GNUmakefile	fix(Make): stop compressing the manpages	2023-02-16 23:23:10 +01:00
go.mod	fix(deps): update module github.com/quic-go/quic-go to v0.42.0	2024-03-18 02:01:09 +00:00
go.sum	fix(deps): update module github.com/quic-go/quic-go to v0.42.0	2024-03-18 02:01:09 +00:00
LICENSE	fix(docs): Totally redesign the readme	2024-03-15 18:16:58 +01:00
main.go	feat: change import URL	2023-02-17 19:18:58 +01:00
main_test.go	feat: Trace (#162 )	2022-12-10 17:51:49 +00:00
Makefile	fix(Make): stop compressing the manpages	2023-02-16 23:23:10 +01:00
mkfile	fix(mk): Add version number in -V	2023-08-11 20:22:16 +02:00
README.md	docs: Add more documentation	2024-03-23 22:00:01 +01:00
renovate.json	misc(deps): Re-enable automerge	2024-03-16 23:47:30 +01:00
template.mk	feat(goreleaser): Vastly simplify upload process (#229 )	2023-11-08 18:02:34 +00:00

README.md

awl (noun): A pointed tool for making small holes in wood or leather

A command-line DNS lookup tool that supports DNS queries over UDP, TCP, TLS, HTTPS, DNSCrypt, and QUIC.

Awl is designed to be a drop-in replacement for dig.

Examples

# Query a domain over UDP
awl example.com

# Query a domain over HTTPS, print only the results
awl example.com +https --short

# Query a domain over TLS, print as JSON
awl example.com +tls +json

For more and the usage, see the manpage.

Installing

On any platform, with Go installed, run the following command to install:

go install dns.froth.zone/awl@latest

Alternatively, many package managers are supported:

Linux

Alpine Linux

Provided by Gitea packages
Any distro that uses apk should also work

# Add the repository
echo "https://git.froth.zone/api/packages/sam/alpine/edge/main" | tee -a /etc/apk/repositories
# Get the signing key
curl -JO https://git.froth.zone/api/packages/sam/alpine/key --output-dir /etc/apk/keys
# Install
apk add awl-dns

Arch

AUR package available as awl-dns-git

yay -S awl-dns-git ||
paru -S awl-dns-git

Debian / Ubuntu

Provided by Gitea packages
Any distro that uses deb/dpkg should also work

# Add PGP key
sudo curl https://git.froth.zone/api/packages/sam/debian/repository.key -o /usr/share/keyrings/git-froth-zone-sam.asc
# Add repo
echo "deb [signed-by=/usr/share/keyrings/git-froth-zone-sam.asc]  https://git.froth.zone/api/packages/sam/debian sid main" | sudo tee /etc/apt/sources.list.d/git-froth-zone-sam.list
# Update and install
sudo apt update
sudo apt install awl-dns

Fedora / RHEL / SUSE

Provided by Gitea packages
Any distro that uses rpm/dnf might also work, I've never tried it

# Add the repository
dnf config-manager --add-repo https://git.froth.zone/api/packages/sam/rpm.repo ||
zypper addrepo https://git.froth.zone/api/packages/sam/rpm.repo
# Install
dnf install awl-dns ||
zypper install awl-dns

Gentoo

# Add the ebuild repository
eselect repository add froth-zone git https://git.froth.zone/packaging/portage.git
emaint sync -r froth-zone
# Install
emerge -av net-dns/awl

Homebrew

brew install SamTherapy/tap/awl

macOS

Homebrew

brew install SamTherapy/tap/awl

Windows

Scoop

scoop bucket add froth https://git.froth.zone/packages/scoop.git
scoop install awl

Contributing

Please see the CONTRIBUTING.md file for more information.

TL;DR: If you like the project, spread the word! If you want to contribute, use the issue tracker or open a pull request. Want to use email instead? Use our mailing list!

Mirrors

The canonical repository is located on my personal Forgejo instance.
Official mirrors are located on GitHub and SourceHut. Contributions are accepted on all mirrors, but the Forgejo instance is preferred.

License

BSD-3-Clause

Credits

Awl image taken from Wikimedia Commons, imaged is licensed CC0.