.. include:: /Includes.rst.txt

.. _verify-cli:

=======================
Verify with T3Vault CLI
=======================

T3Vault ships an integrity verifier that re-hashes artefacts and checks the
OpenTimestamps receipt (via ElephStamp).

This is the **recommended** check before restore: it needs no Bitcoin node and
answers whether the backup files still match :file:`integrity.json`. For an
optional independent check of the ``.ots`` file with the official client, see
:ref:`opentimestamps-manual`.

.. _verify-cli-usage:

Usage
=====

From a development checkout:

.. code-block:: bash

   php t3vault/cli/t3vault-verify.php [--json] [--quiet] [--lang=de|en] <backup-dir>

Or with the offline PHAR (built into the package under Installer resources):

.. code-block:: bash

   php t3vault-verify.phar [--json] [--quiet] [--lang=de|en] <backup-dir>

Example:

.. code-block:: bash

   php t3vault-verify.phar \
     /var/www/html/var/t3vault/backups/backup_20251117_143022_a3f8b2c1

Options:

=============  ==============================================================
Option         Description
=============  ==============================================================
``--json``     Print the full result object as JSON
``--quiet``    Suppress human-readable output (exit code only)
``--lang=``    ``de`` or ``en`` for messages
=============  ==============================================================

Exit codes:

====  =============================================
Code  Meaning
====  =============================================
0     ``ok``
2     ``pending`` / ``stamp_failed`` / ``missing``
1     ``tampered`` or fatal error
====  =============================================

.. note::

   The CLI also accepts ``--upgrade`` (ask calendars to complete a pending
   proof). That is unrelated to detecting file changes and is not needed for
   the usual pre-restore check.