unboundCLI

🌐 UnboundCLI

🚀 A powerful CLI tool for managing Unbound DNS on OPNSense routers with a beautiful interactive interface

UnboundCLI provides seamless DNS override management through the OPNSense API, featuring both command-line operations and an intuitive Text User Interface (TUI).

✨ Features

• 🎨 Modern CLI interface with color output using Cobra and Viper
• 🖥️ Interactive TUI powered by Bubble Tea and Lipgloss
• 📝 Complete CRUD operations for DNS overrides
• 🔐 Secure configuration management
• 🌍 Cross-platform support (macOS, Linux, Windows)
• 🔄 Caddy integration for automatic DNS synchronization
• 🛡️ SLSA Level 3 security compliance

📦 Installation

Using Homebrew (Recommended for macOS and Linux)

brew tap jeeftor/tap
brew install unboundcli

Manual Installation

1. Download the latest binary from the Releases page
2. Extract and move to your $PATH

Building from Source

# Clone the repository
git clone https://github.com/jeeftor/unboundCLI.git
cd unboundCLI

# Build the application
make build

# Install to your GOPATH/bin
make install

🚀 Quick Start

Initial Setup

Configure UnboundCLI with your OPNSense API credentials:

unboundCLI config

Follow the interactive prompts to enter:

• 🔑 API Key
• 🔐 API Secret
• 🌐 OPNSense URL

Launch the TUI

Experience the beautiful interactive interface:

unboundCLI tui

📖 Usage

Usage:
  unboundCLI [command]

Available Commands:
  add         ➕ Add a DNS override
  apply       ✅ Apply pending DNS changes
  caddy-sync  🔄 Synchronize DNS entries with Caddy server
  completion  📝 Generate shell autocompletion script
  config      ⚙️  Configure API connection settings
  delete      🗑️  Delete a DNS override
  edit        ✏️  Edit a DNS override
  find        🔍 Find DNS overrides by host, domain, or both
  help        ❓ Help about any command
  list        📋 List DNS overrides
  tui         💻 Launch the Text User Interface

Flags:
  --config string      config file (default: $HOME/.unboundCLI.yaml)
  -h, --help          help for unboundCLI
  --log-level string  set logging level (debug, info, warn, error) (default: "info")
  -v, --verbose       enable verbose output
  --version           version for unboundCLI

Use "unboundCLI [command] --help" for more information about a command.

Examples

# List all DNS overrides
unboundCLI list

# Add a new DNS override
unboundCLI add --host myserver --domain local.lan --ip 192.168.1.100

# Find specific overrides
unboundCLI find --host myserver

# Launch interactive mode
unboundCLI tui

🛠️ Development

Prerequisites

• Go 1.18 or higher
• Make
• GoReleaser (optional, for releases)

Available Make Commands

make build          # 🔨 Build the application
make test           # 🧪 Run tests
make check          # 🔍 Format code and run linters
make cross-build    # 🌍 Cross-compile for multiple platforms
make release-dry-run # 🚀 Test GoReleaser configuration
make help           # 📚 Show all available commands

🚢 Release Process

This project uses GoReleaser with SLSA Level 3 provenance for secure, automated releases.

Creating a New Release

1. Tag the commit:

   git tag -a v0.1.0 -m "Release v0.1.0"
   git push origin v0.1.0
   

2. Automated build: GitHub Actions automatically builds and publishes the release with SLSA provenance

🛡️ Security & SLSA Provenance

This project follows SLSA Level 3 security practices, providing:

• ✅ Source verification
• 🔒 Build integrity guarantees
• 📋 Provenance generation
• 🛡️ Tamper resistance

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.