⚡️ Zap

Version: v1.2.0 Language: Bash
Install path: ~/bin/zap
Dependencies: yq (v4.x), fzf, ssh, ping

---

⚡️ What is Zap?

Zap is a zero-bullsh*t SSH CLI built for infrastructure engineers who want speed, structure, and style in the terminal.

With YAML-based configuration and interactive fuzzy search, Zap makes jumping into any server fast, fun, and ridiculously efficient.
Forget boring SSH commands — just zap fw paris or zap search and teleport to your servers with style 😎

---

✨ Features

• 🔖 YAML config per category (firewalls, switches, etc)
• 🔍 Fuzzy search with fzf, category filtering
• 👤 Custom SSH user/port per host or category
• 🔁 Interactive add category, add host CLI flows
• 🌐 IP Aliases with connection fallback mechanism
• 💾 Auto backups with purge system
• 📄 Import/export entire or partial configuration (as .tgz archives)
• 🧠 Alias resolution for both categories and hosts
• 🧾 Generate clean /etc/hosts blocks from your Zap config (zap gen hosts)
• 🎯 Direct usage: zap <category> <host> [--ping | SSH opts]
• 🧩 Autocompletion support
• 🛠 Edit existing hosts with zap edit host
• ⏱ Configurable automatic fallback with timeout

---

⚠️ Disclaimer

This tool is provided "as is", without any warranty or guarantee of any kind.

We’ve taken care to make Zap safe, clean, and reliable — but if it breaks your workstation, eats your /etc/hosts, starts an intergalactic war, or makes your laptop burst into flames...
that's on you 🔥💻🤷

Always review what it does — especially when running with sudo.

---

P.S.: Parts of this project were written with the assistance of an AI / Large Language Model (LLM), but the full specifications, code review, final decisions (and bad jokes) are entirely human.

---

⚡️ Quickstart

make install     # Install Zap to ~/bin/zap
zap add category # Start configuring
zap add host     # Add your first host
zap list         # See what's in your config
zap fw myhost    # And boom, you're in 😎

---

🛠️ Installation (Dev Mode)

make install     # Copy zap.sh into ~/bin/zap
make link        # Symlink for live dev mode
make update      # Push updates to ~/bin
make uninstall   # Remove from your system

---

⚙️ Commands

zap help                          # Show usage
zap version                       # Display current version
zap add category                  # Add new category (with emoji, user, port)
zap add host                      # Add host under a category
zap edit host                     # Edit an existing host (IP, aliases, etc.)
zap list [<category>]             # Show hosts by category
zap search [<category>]           # Interactive fuzzy search
zap export all                    # Export entire config as .tgz
zap export settings               # Export only global settings
zap export category <cat> [...]   # Export selected categories
zap import <file.tgz>             # Import and merge from a .tgz archive
zap gen hosts [--write]           # Generate a /etc/hosts block (with optional write to file)
zap config auto-fallback <true|false> # Configure automatic IP alias fallback
zap config fallback-timeout <seconds> # Set the timeout for automatic fallback
zap <cat> <host> [opts]           # SSH into a host or ping (add --ping)

---

📁 Where Zap stores stuff

Zap keeps its config in:

~/.config/zap/
├── config.yml               # global settings & category metadata
├── categories/              # one YAML file per category
├── backups/                 # automatic versioned backups

---

🔒 Example: config.yml

categories:
  firewalls:
    emoji: 🔥
    default_user: admin
    default_port: 22
    aliases: [fw, firewall]

And categories/firewalls.yml:

hosts:
  paris-fw-1:
    ip: 1.1.1.1
    ip_aliases:
      - 2.2.2.2
      - 3.3.3.3
    username: admin
    port: 22
    aliases:
      - paris
      - paris-fw1
      - pfw1

---

📦 Import / Export Examples

Export everything:

zap export all

Export just global config:

zap export settings

Export only specific categories:

zap export category firewalls switches

Import from a file:

zap import team_zap_config.tgz

---

Designed for fun, in France, by Maiko BOSSUYT.