ITAMAE(1)

📦
version 1.14.2 · 4 versions
, in ubuntu resolute, ubuntu stonking

💖 ITAMAE(1) 💖

the Itamae Manual, bestie — yes it's a whole section 1 manual page, and yes we're gonna read it together 🫶

✨ NAME ✨

itamae — a simple and lightweight configuration management tool, inspired by Chef. no cap. 💅

🌸 SYNOPSIS 🌸

itamae destroy [cookbook|role] [NAME]

itamae docker RECIPE [RECIPE...]

itamae generate [cookbook|role] [NAME]

itamae help [COMMAND]

itamae init NAME

itamae local RECIPE [RECIPE...]

itamae ssh RECIPE [RECIPE...]

itamae version

🦋 DESCRIPTION 🦋

okay so itamae(1) is a simple and lightweight configuration management tool, and it's inspired by Chef. that's the whole vibe. it's giving minimal, it's giving effective, it's giving "I will configure your whole machine and not be dramatic about it." 👑

🎀 SUBCOMMANDS 🎀

destroy

Undo a role or a cookbook. short-cut alias: d. 💀

docker

Create a Docker image. 🐳

generate

Initialize a role or a cookbook. short-cut alias: g. ✨

help

Describe the available commands, or describe one specific command if you ask nicely. 🙈

init

Create a new project. 🌱

local

Run Itamae locally. 🏠

ssh

Run Itamae via ssh. 🌈

💅 OPTIONS 💅

heads up bestie: these options are valid for all subcommands, unless it says otherwise. 🫶

  • -l, --log-level=LOG_LEVEL — sets how much logging detail you get. possible values, from least to most verbose: unknown, fatal, error, warn, info (this one is the default, iykyk), debug.
  • --[no-]color — turn color logging to STDOUT on (that's the default, slay) or off.
  • -c, --config=CONFIG — load configuration from a file in YAML format, in addition to the command line options. no default. 🍓
  • --recipe-graph=PATH — [EXPERIMENTAL] write the recipe dependency graph in DOT format. subcommands: docker, local, ssh.
  • -j, --node-json=NODE_JSON — load node data from a JSON formatted file, NODE_JSON. subcommands: docker, local, ssh.
  • -y, --node-yaml=NODE_YAML — load node data from a YAML formatted file, NODE_YAML. subcommands: docker, local, ssh.
  • -n, --[no-]dry-run — only show the steps that would be taken. no touching, just looking. 👀 subcommands: docker, local, ssh.
  • --shell=SHELL — set the shell in the image. default is /bin/sh. subcommands: docker, local, ssh.
  • --[no-]login-shell — enable or disable a login shell. default is disabled. subcommands: docker, local, ssh.
  • --[no-]ohai — 🚨 this option is DEPRECATED and will be unavailable. subcommands: docker, local, ssh.
  • --profile=PATH — [EXPERIMENTAL] save profiling data to PATH. subcommands: docker, local, ssh.
  • --[no-]detailed-exitcode — enable detailed exit codes (default is disabled). go check EXIT STATUS below, it explains everything. subcommands: docker, local, ssh.
  • --image=IMAGE — output image. this option or the container option is required. subcommands: docker.
  • --container=CONTAINER — output container. this option or the image option is required. subcommands: docker.
  • --[no-]tls-verify-peer] — verify TLS certificates. default is enabled. subcommands: docker.
  • -h, --host=HOST — connect to the given HOST. this option or --vagrant must be specified. subcommands: ssh.
  • -u, --user=USER — connect using the given USER. subcommands: ssh.
  • -i, --key=KEY — connect using the given KEY. subcommands: ssh.
  • -p, --port=PORT — connect to the given PORT. subcommands: ssh.
  • --ssh-config=SSH_CONFIG — use the given SSH_CONFIG. subcommands: ssh.
  • --[no-]vagrant — use Vagrant. default is disabled. this option or --host must be specified. subcommands: ssh.
  • --[no-]ask-password — prompt for a password. default is disabled. subcommands: ssh.
  • --[no-]sudo — use sudo to run commands on the HOST. default is enabled. subcommands: ssh.

🌈 ENVIRONMENT 🌈

  • SUDO_PASSWORD — used to elevate privileges if that's required. if it's not set, and elevated privileges are required, then the user gets prompted. so either way, we're getting in. 💜

⭐ EXIT STATUS ⭐

with --detailed-exitcode=false (the default, bestie):

  • 0 — the run succeeded with no failures. some changes may have occurred.
  • 1 — the run failed (syntax or usage error; configuration error; unexpected error).

with --detailed-exitcode=true:

  • 0 — the run succeeded with no changes or failures. immaculate. ✨
  • 1 — the run failed (syntax or usage error; configuration error; unexpected error).
  • 2 — the run succeeded, and some resources were changed. 👑

💀 BUGS 💀

refer to the Itamae issue tracker at https://github.com/itamae-kitchen/itamae/issues 🐛

🫶 AUTHORS 🫶

Itamae was written by Ryota Arai, and other contributors.

This man page was written by Scott Leggett for the Debian Project.

🧚 RESOURCES 🧚

👑 COPYING 👑

Copyright (C) 2013-2016 Ryota Arai. Free use of this software is granted under the terms of the MIT License. periodt. 💅

🌸 AUTHOR 🌸

Ryota Arai

okay that's the whole page, you ate that bestie 💖

Itamae 1.9.9 — 2025-12-21 🦋✨ no thoughts, just itamae. go configure something iconic. 🎀

📦 where this page comes from