'\" t
.\"     Title: itamae
.\"    Author: Ryota Arai
.\" Generator: Asciidoctor 2.0.12
.\"      Date: 2020-12-30
.\"    Manual: Itamae Manual
.\"    Source: Itamae 1.9.9
.\"  Language: English
.\"
.TH "ITAMAE" "1" "2020-12-30" "Itamae 1.9.9" "Itamae Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
itamae \- Simple and lightweight configuration management tool inspired by Chef.
.SH "SYNOPSIS"
.sp
\fBitamae destroy\fP [cookbook|role] [\fINAME\fP]
.sp
\fBitamae docker\fP \fIRECIPE\fP [\fIRECIPE\fP...]
.sp
\fBitamae generate\fP [cookbook|role] [\fINAME\fP]
.sp
\fBitamae help\fP [\fICOMMAND\fP]
.sp
\fBitamae init\fP \fINAME\fP
.sp
\fBitamae local\fP \fIRECIPE\fP [\fIRECIPE\fP...]
.sp
\fBitamae ssh\fP \fIRECIPE\fP [\fIRECIPE\fP...]
.sp
\fBitamae version\fP
.SH "DESCRIPTION"
.sp
itamae(1) is a simple and lightweight configuration management tool inspired by Chef.
.SH "SUBCOMMANDS"
.SS "destroy"
.sp
Undo role or cookbook (short\-cut alias \fBd\fP).
.SS "docker"
.sp
Create Docker image.
.SS "generate"
.sp
Initialize role or cookbook (short\-cut alias: \fIg\fP).
.SS "help"
.sp
Describe available commands or one specific command.
.SS "init"
.sp
Create a new project.
.SS "local"
.sp
Run Itamae locally.
.SS "ssh"
.sp
Run Itamae via ssh.
.SH "OPTIONS"
.sp
Options are valid for all subcommands unless otherwise noted.
.sp
\fB\-l, \-\-log\-level\fP=\fILOG_LEVEL\fP
.RS 4
Set the level of logging detail.
Possible values, in increasingly verbose order, \fIunknown\fP, \fIfatal\fP, \fIerror\fP, \fIwarn\fP, \fIinfo\fP (the default), \fIdebug\fP.
.RE
.sp
\fB\-\-[no\-]color\fP
.RS 4
Enable (the default) or disable color logging to STDOUT.
.RE
.sp
\fB\-c, \-\-config\fP=\fICONFIG\fP
.RS 4
Load configuration from a file in YAML format in addition to command line options (no default).
.RE
.sp
\fB\-\-recipe\-graph\fP=\fIPATH\fP
.RS 4
[EXPERIMENTAL] Write recipe dependency graph in DOT.
.sp
Subcommands: \fBdocker\fP, \fBlocal\fP, \fBssh\fP.
.RE
.sp
\fB\-j, \-\-node\-json\fP=\fINODE_JSON\fP
.RS 4
Load node data from a JSON formatted file, \fINODE_JSON\fP.
.sp
Subcommands: \fBdocker\fP, \fBlocal\fP, \fBssh\fP.
.RE
.sp
\fB\-y, \-\-node\-yaml\fP=\fINODE_YAML\fP
.RS 4
Load node data from a YAML formatted file, \fINODE_YAML\fP.
.sp
Subcommands: \fBdocker\fP, \fBlocal\fP, \fBssh\fP.
.RE
.sp
\fB\-n, \-\-[no\-]dry\-run\fP
.RS 4
Only show the steps that would be taken.
.sp
Subcommands: \fBdocker\fP, \fBlocal\fP, \fBssh\fP.
.RE
.sp
\fB\-\-shell\fP=\fISHELL\fP
.RS 4
Set the shell in the image. Default \fI/bin/sh\fP.
.sp
Subcommands: \fBdocker\fP, \fBlocal\fP, \fBssh\fP.
.RE
.sp
\fB\-\-[no\-]login\-shell\fP
.RS 4
Enable or disable a login shell. Default disabled.
.sp
Subcommands: \fBdocker\fP, \fBlocal\fP, \fBssh\fP.
.RE
.sp
\fB\-\-[no\-]ohai\fP
.RS 4
This option is DEPRECATED and will be unavailable.
.sp
Subcommands: \fBdocker\fP, \fBlocal\fP, \fBssh\fP.
.RE
.sp
\fB\-\-profile\fP=\fIPATH\fP
.RS 4
[EXPERIMENTAL] Save profiling data to \fIPATH\fP.
.sp
Subcommands: \fBdocker\fP, \fBlocal\fP, \fBssh\fP.
.RE
.sp
\fB\-\-[no\-]detailed\-exitcode\fP
.RS 4
Enable detailed exit codes (default disabled). See \fBEXIT STATUS\fP.
.sp
Subcommands: \fBdocker\fP, \fBlocal\fP, \fBssh\fP.
.RE
.sp
\fB\-\-image\fP=\fIIMAGE\fP
.RS 4
Output image. This option or \(aqcontainer\(aq option is required.
.sp
Subcommands: \fBdocker\fP.
.RE
.sp
\fB\-\-container\fP=\fICONTAINER\fP
.RS 4
Output container. This option or \(aqimage\(aq option is required.
.sp
Subcommands: \fBdocker\fP.
.RE
.sp
\fB\-\-[no\-]tls\-verify\-peer]\fP
.RS 4
Verify TLS certificates. Default enabled.
.sp
Subcommands: \fBdocker\fP.
.RE
.sp
\fB\-h, \-\-host\fP=\fIHOST\fP
.RS 4
Connect to the given \fIHOST\fP. This option or \fB\-\-vagrant\fP must be specified.
.sp
Subcommands: \fBssh\fP.
.RE
.sp
\fB\-u, \-\-user\fP=\fIUSER\fP
.RS 4
Connect using the given \fIUSER\fP.
.sp
Subcommands: \fBssh\fP.
.RE
.sp
\fB\-i, \-\-key\fP=\fIKEY\fP
.RS 4
Connect using the given \fIKEY\fP.
.sp
Subcommands: \fBssh\fP.
.RE
.sp
\fB\-p, \-\-port\fP=\fIPORT\fP
.RS 4
Connect to the given \fIPORT\fP.
.sp
Subcommands: \fBssh\fP.
.RE
.sp
\fB\-\-ssh\-config\fP=\fISSH_CONFIG\fP
.RS 4
Use the given \fISSH_CONFIG\fP.
.sp
Subcommands: \fBssh\fP.
.RE
.sp
\fB\-\-[no\-]vagrant\fP
.RS 4
Use Vagrant. Default disabled. This option or \fB\-\-host\fP must be specified.
.sp
Subcommands: \fBssh\fP.
.RE
.sp
\fB\-\-[no\-]ask\-password\fP
.RS 4
Prompt for a password. Default disabled.
.sp
Subcommands: \fBssh\fP.
.RE
.sp
\fB\-\-[no\-]sudo\fP
.RS 4
Use sudo to run commands on the \fIHOST\fP. Default enabled.
.sp
Subcommands: \fBssh\fP.
.RE
.SH "ENVIRONMENT"
.sp
\fBSUDO_PASSWORD\fP
.RS 4
Used to elevate privileges if required. If not set, and elevated privileges are required, the user will be prompted.
.RE
.SH "EXIT STATUS"
.sp
With \fB\-\-detailed\-exitcode=false\fP (default):
.sp
\fB0\fP
.RS 4
The run succeeded with no failures, some changes may have occurred.
.RE
.sp
\fB1\fP
.RS 4
The run failed (syntax or usage error; configuration error; unexpected error).
.RE
.sp
With \fB\-\-detailed\-exitcode=true\fP:
.sp
\fB0\fP
.RS 4
The run succeeded with no changes or failures.
.RE
.sp
\fB1\fP
.RS 4
The run failed (syntax or usage error; configuration error; unexpected error).
.RE
.sp
\fB2\fP
.RS 4
The run succeeded, and some resources were changed.
.RE
.SH "BUGS"
.sp
Refer to the \fBItamae\fP issue tracker at \c
.URL "https://github.com/itamae\-kitchen/itamae/issues" "" ""
.SH "AUTHORS"
.sp
\fBItamae\fP was written by Ryota Arai, and other contributors.
.sp
This man page was written by Scott Leggett for the Debian Project.
.SH "RESOURCES"
.sp
\fBProject web site:\fP \c
.URL "http://itamae.kitchen/" "" ""
.sp
\fBGit source repository on GitHub:\fP \c
.URL "https://github.com/itamae\-kitchen/itamae" "" ""
.sp
\fBGitHub organization:\fP \c
.URL "https://github.com/itamae\-kitchen" "" ""
.SH "COPYING"
.sp
Copyright (C) 2013\-2016 Ryota Arai.
Free use of this software is granted under the terms of the MIT License.
.SH "AUTHOR"
.sp
Ryota Arai