From 9e5885907c0273c8f26c128c673388c40b2809b6 Mon Sep 17 00:00:00 2001 From: mhoennig Date: Sat, 5 Sep 2026 14:04:12 +0200 Subject: [PATCH] docs: explain the optional repo-add name --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 84b9a65..142b3f8 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ tools/remote --env-file .env. werkator repo-add https://gitea.example. ``` It prints the registry entry: add it to `~/.werkator.yml` under `repositories:`, then restart the service. +The optional `[]` overrides the directory basename: it becomes the route segment (`/repos//…`) and the UI switcher entry, so it must be unique. +Needed only when the clone directory name is wrong or collides — e.g. `michael.hoennig.de.git` checked out as `michael.hoennig.de`, or two forges serving a repo of the same name. A **public** repository needs nothing else: the clone runs anonymously. A **private** repository needs shared credentials once on the host, in `~/.werkator.yml` of the service user, before cloning: