What happens without asking #

View this page as Markdown

The tool asks nothing. It has no prompt, no interactive mode, and no configuration file. Everything it does follows from its command line. This page lists what it reads, writes, and sends, and the three actions an AI agent running it confirms with you first.

What it reads #

A check reads the folder given with --source and every Markdown file under it. A build reads those and the files given with --shell, --home-opening, and --stylesheet. Neither reads anything else: no configuration file, no environment variable, and no file outside those paths.

What it writes #

A check writes nothing. A build writes into these places and nowhere else:

  • the folder given with --out, whose entire previous contents the new site replaces;
  • the output folder's missing parent folders, which it creates;
  • two temporary folders beside the output folder: a staging folder and, where a previous site exists, a backup folder.

A successful build removes the temporary folders. A failed build reports any folder it leaves, and Output says what each one contains. The tool never edits a source file. To fix a finding, you or your agent edit the source file.

What it sends #

Nothing. The tool opens no network connection, fetches no external link, and reports no usage. A check does not fetch the external addresses a page links to.

What an agent confirms first #

An agent running the tool on your behalf can run tzdocs check at any time, because it writes nothing. The agent confirms three actions with you before running them:

  • Building into a folder that contains anything other than a previous build. The output folder is replaced whole, so a folder that also contains other files loses them.
  • Building with --include-hidden for a site that is served openly. The flag builds the hidden pages into the tree and into every machine file, and only the server hosting the site can then withhold them.
  • Deleting a backup folder a failed build reported. A .tzdocs-backup-* folder named in an error message keeps the previous site until it is recovered.

Everything else needs no confirmation beyond the request that started the task: running the check, building into the dedicated output folder, and fixing the source files the findings mention.

  • Getting started gives the two commands and the flags.
  • Output says what a failed replacement leaves behind.