https://github.com/felicianotech/sonar
A Docker utility to manager image and tag information from Docker Hub.
https://github.com/felicianotech/sonar
docker hacktoberfest
Last synced: 6 months ago
JSON representation
A Docker utility to manager image and tag information from Docker Hub.
- Host: GitHub
- URL: https://github.com/felicianotech/sonar
- Owner: FelicianoTech
- License: mit
- Created: 2020-08-02T22:55:51.000Z (almost 6 years ago)
- Default Branch: trunk
- Last Pushed: 2023-05-11T20:45:13.000Z (about 3 years ago)
- Last Synced: 2025-10-17T07:51:11.105Z (9 months ago)
- Topics: docker, hacktoberfest
- Language: Go
- Homepage:
- Size: 706 KB
- Stars: 13
- Watchers: 2
- Forks: 5
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sonar - the Docker utility [](https://app.circleci.com/pipelines/github/felicianotech/sonar) [](https://raw.githubusercontent.com/felicianotech/sonar/trunk/LICENSE) [][orb-page]
Sonar is the Docker and Docker Hub utility that you've been missing.
It can display information on Docker images, tags, and layers including the packages installed in those images.
Docker Hub metrics such as stars and pulls can be read while tasks such as updating the readme, summary, or even deleting tags from Docker Hub can be done with Sonar.
## Table of Contents
- [Install Sonar](#install-sonar)
- [Linux](#linux)
- [macOS](#macos)
- [Windows](#windows)
- [Continuous Integration (CI) Systems](#continuous-integration-ci-systems)
- [Configuring](#configuring)
- [Features](#features)
## Install Sonar
### Linux
There are a few ways you can install Sonar on a Linux amd64 or arm64 system.
#### Ubuntu Apt Repository (recommended)
I (Ricardo N Feliciano) run an Apt/Debian repository for a lot of my software, which includes Sonar.
The benefit of the Apt repository is that updates are handled by Ubuntu's built-in package manager.
For security reasons, first we install the GPG key for the repository:
```bash
sudo wget "http://pkg.feliciano.tech/ftech-archive-keyring.gpg" -P /usr/share/keyrings/
```
Now we add the repository to the system:
```bash
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/ftech-archive-keyring.gpg] http://pkg.feliciano.tech/ubuntu $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/felicianotech.list
```
Finally, we can install Sonar:
```bash
sudo apt update && sudo apt install sonar
```
#### Debian Package (.deb)
You can install Sonar into an Apt based computer by download the `.deb` file to the desired system.
For graphical systems, you can download it from the [GitHub Releases page][gh-releases].
Many distros allow you to double-click the file to install.
Via terminal, you can do the following:
```bash
wget https://github.com/felicianotech/sonar/releases/download/v0.19.0/sonar_0.19.0_amd64.deb
sudo dpkg -i sonar_0.19.0_amd64.deb
```
`0.19.0` and `amd64` may need to be replaced with your desired version and CPU architecture respectively.
#### Binary Install
You can download and run the raw Sonar binary from the [GitHub Releases page][gh-releases] if you don't want to use any package manager.
Simply download the tarball for your OS and architecture and extract the binary to somewhere in your `PATH`.
Here's one way to do this with `curl` and `tar`:
```bash
dlURL="https://github.com/felicianotech/sonar/releases/download/v0.19.0/sonar-v0.19.0-linux-amd64.tar.gz"
curl -sSL $dlURL | sudo tar -xz -C /usr/local/bin sonar
```
`0.19.0` and `amd64` may need to be replaced with your desired version and CPU architecture respectively.
### macOS
There are two ways you can install Sonar on macOS. Both x86 Macs and Apple Silicon (arm64-based chips, including M1 and M2) are supported.
#### Brew (recommended)
Installing Sonar via Homebrew is a simple one-liner:
```bash
brew install felicianotech/tap/sonar
```
#### Binary Install
You can download and run the raw Sonar binary from the [GitHub Releases page][gh-releases] if you don't want to use Brew.
Simply download the tarball for your OS and architecture and extract the binary to somewhere in your `PATH`.
Here's one way to do this with `curl` and `tar`:
```bash
dlURL="https://github.com/felicianotech/sonar/releases/download/v0.19.0/sonar-v0.19.0-macos-amd64.tar.gz"
curl -sSL $dlURL | sudo tar -xz -C /usr/local/bin sonar
```
`0.19.0` may need to be replaced with your desired version.
### Windows
Sonar supports Windows 10 by downloading and installing the binary.
Chocolately support is likely coming in the future.
If there's a Windows package manager you'd like support for (including Chocolately), please open and Issue and ask for it.
#### Binary Install (exe)
You can download and run the Sonar executable from the [GitHub Releases page][gh-releases].
Simply download the zip for architecture and extract the exe.
### Continuous Integration (CI) Systems
Sonar can be installed in a CI environment pretty much the same way you'd install it on your own computer.
There is 1st-party support for some CI platforms in order to make the process easier.
#### CircleCI
Sonar can be installed in a CircleCI build by using the [Sonar CircleCI Orb][orb-page].
Please visit that link for more instructions.
#### GitHub Actions
Coming soon, probably.
Open an Issue to request it and demonstrate demand.
## Configuring
Most commands don't need authentication.
Some, such as `sonar set description`, require Docker / Docker Hub credentials.
These can be set via the environment variables `DOCKER_USER` and `DOCKER_PASS`.
You can also set the password specifically with the global `--password` flag.
Please be careful with this, you don't want a password in your shell history.
The suggestion is to pass an environment variable (that isn't already `DOCKER_PASS`) by doing something like this:
```bash
sonar set readme my/image --password=$THE_PASSWORD_ENVAR ./file.md
```
## Features
*Lists* - List images belonging to a namespace and tags belonging to an image.
*Metadata* - Set your image's Docker Hub description from the command-line.
*Packages* - List the Apt/deb, RPM, and/or Pip packages installed in an image.
*Tag Deletion* - Delete tags on Docker Hub individually or in bulk.
Run `sonar help` to see all commands available.
## License
This repository is licensed under the MIT license.
The license can be found [here](./LICENSE).
[gh-releases]: https://github.com/felicianotech/sonar/releases
[orb-page]: https://circleci.com/developer/orbs/orb/hubci/sonar