.. module:: aunt

:mod:`aunt` --- Auto Unattend
=============================

``aunt`` automates Windows installation with AutoUnattend.xml_ and reduces
`image <https://msdn.microsoft.com/en-us/library/windows/desktop/dd861280.aspx>`_ size.

.. _AutoUnattend.xml: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/automate-windows-setup


Dependencies
------------

* `Python <https://www.python.org>`_ 3.6+
* `7-Zip <https://www.7-zip.org>`_
* `Oscdimg <http://phyl.io/oscdimg.exe>`_ --- *add to Path*


Usage
-----

``aunt -h`` shows the help, ``aunt`` without argument checks dependencies then shows the help:

.. literalinclude:: ../aunt/help.txt
	:language: text

``aunt Windows.iso`` rewrites the bootable `UDF <http://www.osta.org/specs/>`_ ``*.iso`` and shows the steps:

.. literalinclude:: ../aunt/out.txt
	:language: text

``aunt -v Windows.iso`` details actions in `bash <https://www.gnu.org/software/bash/>`_ syntax,
words ``grep`` ``mv`` ``rm`` are handy for understanding what's going on,
although these actions are written in pure Python:

.. literalinclude:: ../aunt/out-v.txt
	:language: text

The `dism <https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/dism---deployment-image-servicing-and-management-technical-reference-for-windows>`_
commands above strips all Windows editions other than the one chosen by the ``-e`` option.
Without ``-e`` assumes that the desired edition is the same as the host's ``EditionID``.

``-a`` equals ``-mny`` and generates an AutoUnattend.xml_ as below:

.. literalinclude:: AutoUnattend.xml
	:language: xml

Exit status:

	**0**: success **1**: missing file **2**: missing edition in image file


Screens
-------

Hidden screen, ``--lang`` or ``lang.ini`` sets the language:

.. image:: aunt/00.png

Hidden screen:

.. image:: aunt/01.png

Hidden screen, ``--key`` sets the activation key otherwise continues without a key:

.. image:: aunt/10.png

Hidden screen, ``--edition`` or host's ``EditionID`` sets the Windows edition:

.. image:: aunt/11.png

``--yes`` accepts the license and hides this screen:

.. image:: aunt/12.png

Hidden screen, chooses *"Custom"* installation:

.. image:: aunt/13.png

Displayed:

.. image:: aunt/14.png
.. image:: aunt/15.png

3 hidden screens, ``--lang`` or ``lang.ini`` sets the language:

.. image:: aunt/20.png
.. image:: aunt/21.png
.. image:: aunt/22.png

``--network`` hides these 2 screens:

.. image:: aunt/23.png
.. image:: aunt/24.png

``--microsoft`` hides these 2 screens:

.. image:: aunt/25.png
.. image:: aunt/26.png

Displayed:

.. image:: aunt/27.png
.. image:: aunt/28.png
.. image:: aunt/30.png
.. image:: aunt/31.png
.. image:: aunt/32.png

Writing ``HKLM\Software\Microsoft\Windows\CurrentVersion\Policies\System\EnableFirstLogonAnimation = 0``
in ``install.esd`` is the only way to hide this animation,
``<FirstLogonCommands>`` runs too late:

.. image:: aunt/40.png


Tests
-----

💿 English x64 💿 French x64 --- Home Professional Education [1]_ --- `VirtualBox <https://www.virtualbox.org/>`_ 6 --- MBR:

:1809: November 13, 2018 --- *Redstone 5*

.. [1] Education is Enterprise edition without long-term support


To do
-----

* UEFI


Versions
--------

:0.1: February 16, 2019 --- *First alpha release*