---
numbering:
  title: true
---

# `arch.tools`: Architectonic Command-Line Tools

```{py:currentmodule} arch.tools
```

The `tools` subpackage collects the CLI utilities that operate on an architectonic repository: `tree` (`TreeViz`) renders the element tree in the terminal, `sync` (`ArchFactory`) synchronizes the local filesystem and database with the Google Sheet ground truth, and `setup_tool` configures logging for all of them.
Additional console scripts (`apply_edit`, `set_dircolors`) live in the `mod` and `dev` submodules.

The package installs five console scripts, each backed by a `main()` entry point:

- **`tree`** — `arch.tools.viz.tree:main`, walks and colorizes the element tree.
- **`sync`** — `arch.tools.mod.sync:main`, reconciles the sheet, filesystem, and database.
- **`apply_edit`** — `arch.tools.mod.apply_edit:main`, applies a transformation task across matching files (via the `Applier` subclass of `TreeViz`).
- **`set_dircolors`** — `arch.tools.dev.set_dircolors:main`, rebuilds the `LS_COLORS` export from the irix palette.
- **`assay`** — `arch.tools.assay.cli:main`, grades every decision in an architectonic (`gather`/`grade`/`run`).

```{eval-rst}
.. autofunction:: arch.tools.setup_tool
```

```{toctree}
:maxdepth: 2
tools.TreeViz
tools.ArchFactory
tools.assay
```