honey inventory

honey inventory

Print Ansible-compatible JSON dynamic inventory from the same search as honey search

Synopsis

Runs the same parallel discovery as honey search (all search flags apply), then prints JSON suitable for Ansible's script inventory plugin: with --list (or no --host), a top-level object with a honey group, optional honey_provider_, honey_region_, honey_zone_* groups, and _meta.hostvars.

Each host gets ansible_host from the discovered PrimaryIP when present, ansible_user from --ssh-user (or config defaults.ssh_user), plus honey_* variables and honey_meta_* keys from record meta.

Ansible's -i flag takes a path to an inventory file or directory (or multiple paths), not a shell command. For script inventory, use a small executable wrapper that runs "honey inventory ..." and forwards "$@".

To avoid a wrapper, use the YAML inventory plugin in contrib/ansible/inventory_plugins/honey.py (see contrib/ansible/honey.gcp.example.yml and examples/ansible/README.md).

For CI, AWX, or Ansible Tower: install honey, inject credentials like honey search, then either set ANSIBLE_INVENTORY_PLUGINS to that directory and use a plugin YAML with -i, or use a wrapper script.

honey inventory [name] [flags]

Options

      --aws-profile string            AWS shared config profile
      --aws-region string             AWS region (default: from profile/env)
      --backends string               Comma-separated backend names (YAML backends.*.name); only those entries run
      --blacklist strings             Comma-separated list of tags or label keys to ignore (e.g. 'webserver,label_env')
      --consul-addr string            Consul HTTP address (host:port, default CONSUL_HTTP_ADDR)
      --consul-datacenter string      Consul datacenter
      --consul-token string           Consul ACL token (or CONSUL_HTTP_TOKEN)
      --docker-all                    Include stopped containers in docker search
      --docker-host string            Docker host (unix://, tcp://, ssh://; default: DOCKER_HOST / local socket)
      --docker-mode string            Docker search mode: containers, swarm, or both (default "containers")
      --docker-platform string        Remote Docker host OS: linux or windows (default "linux")
      --docker-socket string          Remote Docker socket (default /var/run/docker.sock on linux)
      --docker-via-local string       Docker via Honey SSH: backends.local name
      --docker-via-ssh-host string    Docker via Honey SSH: explicit host
      --filter stringArray            Post-discovery filter (repeatable: group:web, var:service=nginx)
      --gcp-project string            GCP project (or GOOGLE_CLOUD_PROJECT / GCP_PROJECT)
      --gcp-zone string               Limit GCP to a single zone (default: all zones)
  -h, --help                          help for inventory
      --host string                   Ansible script inventory: emit JSON object of host variables for this inventory name; unknown hosts print {}
      --json                          Print results as JSON (same as --output=json)
      --k8s-debug-image string        Container image used for ephemeral debug containers (default: alpine:3.23)
      --k8s-mode string               Kubernetes search mode: nodes or pods (default "nodes")
      --kube-context string           Kubernetes context override
      --kubeconfig string             Path to kubeconfig file
      --list                          Ansible script inventory: emit full JSON (Ansible passes this; optional when not using --host)
      --name string                   Substring filter on instance/node/pod name (case-insensitive)
      --name-regex string             Regex filter on name (overrides --name substring)
      --no-ui                         Skip interactive UI (same as --output=json)
  -o, --output string                 Output format: tui, table, json (default "tui")
      --provider string               Comma-separated: gcp,aws,k8s,consul,proxmox,truenas,docker,local (default: all)
      --proxmox-insecure              Skip TLS verification for Proxmox
      --proxmox-password string       Proxmox password
      --proxmox-token-id string       Proxmox token ID (e.g. root@pam!token)
      --proxmox-token-secret string   Proxmox token secret
      --proxmox-url string            Proxmox API URL (e.g. https://10.0.0.1:8006/api2/json)
      --proxmox-user string           Proxmox user (e.g. root@pam)
      --ssh-user string               Default SSH user for connect actions (defaults to config or OS user)
      --strip-prefix                  Remove 'honey_' prefix from Ansible groups and host variables
      --truenas-api-key string        TrueNAS API key (or TRUENAS_API_KEY)
      --truenas-insecure              Skip TLS verification for TrueNAS
      --truenas-url string            TrueNAS SCALE URL (https://host or wss://host/api/current)
      --truenas-user string           TrueNAS API key username (default root)

Options inherited from parent commands

      --cache-dir string     Override cache directory (default: XDG_CACHE_HOME/honey)
      --cache-ttl duration   Cache time-to-live (host discovery) (default 10m0s)
      --config string        Path to honey YAML (optional; also HONEY_CONFIG or default paths)
      --debug-log string     Path to write debug logs (disables debug logging if empty)
      --no-cache             Bypass read/write cache (host discovery)
      --record-dir string    Session recording directory for search (TUI), web, and cue-exec; overrides defaults.record_dir; default <directory of config.yaml>/records
      --refresh              Ignore cached entries and refresh (host discovery)

SEE ALSO

• honey - DevOps tool to help find an instance in sea of clouds