Skip to content

pkg

Manage system packages (install/remove/update)

Properties

Property Type Required Description
cask boolean No -
extra array No -
manager string No Package manager (auto-detected if empty: apt, dnf, yum, pacman, zypper, apk, brew, port, choco, scoop)
name string No Package name (single package)
names array No Multiple packages to install/remove
state string No Package state (present: installed, absent: removed, latest: install or upgrade) (allowed: present, absent, latest)
update_cache boolean No Update package cache before operation (e.g., apt-get update)
upgrade boolean No -

Examples

# Install a single package (auto-detects manager: apt/dnf/brew/...)
- name: Install ripgrep
  pkg:
    name: ripgrep
    state: present
# Install several with a cache refresh
- name: Dev essentials
  pkg:
    names: [git, make, jq, curl]
    state: present
    update_cache: true
# Upgrade an already-installed package to latest
- pkg:
    name: nginx
    state: latest

Platform Support

linux, darwin, windows, freebsd

Events Emitted

  • package.managed