From 1a018015c575e1ebd68c8ffc0427c1e47716288b Mon Sep 17 00:00:00 2001 From: Max Audron Date: Tue, 6 Jan 2026 23:21:27 +0100 Subject: update README --- README.md | 12 +++--------- README.org | 61 ------------------------------------------------------------- 2 files changed, 3 insertions(+), 70 deletions(-) delete mode 100644 README.org diff --git a/README.md b/README.md index 5f5e4c7..a36722d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,11 @@ +[![git mirror](https://img.shields.io/badge/git-repo-cba6f7?logo=git&link=https%3A%2F%2Fgit.vapor.systems%2Fgtree.git)](https://git.vapor.systems/gtree.git) +[![github mirror](https://img.shields.io/badge/github-repo-blue?logo=github&link=https%3A%2F%2Fgithub.com%2Fmaxaudron%2Fgtree)](https://github.com/maxaudron/gtree) +[![gitlab mirror](https://img.shields.io/badge/gitlab-repo-orange?logo=github&link=https%3A%2F%2Fgitlab.com%2Fcocainefarm%2Fgtree)](https://gitlab.com/cocainefarm/gtree) # Table of Contents -1. [Usage](#org86116bf) -2. [Config](#org4e7be59) - A tool to clone and pull whole group trees from a git forge, properly organized on disk. - - - # Usage gtree @@ -30,9 +27,6 @@ A tool to clone and pull whole group trees from a git forge, properly organized sync Download new repositories and delete old ones, also update update Pull and Push new commits to and from the cloned repos - - - # Config Default location for the config file is `$HOME/.config/gtree/config.toml`, in the toml format, yaml is also supported. diff --git a/README.org b/README.org deleted file mode 100644 index 4a18e14..0000000 --- a/README.org +++ /dev/null @@ -1,61 +0,0 @@ -#+title: gtree - -A tool to clone and pull whole group trees from a git forge, properly organized on disk. - -* Usage -#+begin_src -gtree -Sync Gitlab Trees - -USAGE: - gtree [SCOPE] - -ARGS: - Only operate on this subtree - -OPTIONS: - -h, --help Print help information - -j, --jobs Number of jobs to run in parallel, 0 is automatic [default: 0] - -SUBCOMMANDS: - help Print this message or the help of the given subcommand(s) - list List Directories - sync Download new repositories and delete old ones, also update - update Pull and Push new commits to and from the cloned repos -#+end_src - -* Config -Default location for the config file is ~$HOME/.config/gtree/config.toml~, in the toml format, yaml is also supported. - -#+begin_src toml -# Give the forge a easily identifiable name -["gitlab.com"] -# Configure which kind of forge this is -# Currently only gitlab is supported -type = "gitlab" - -# Set the domain name to reach the forge at -host = "gitlab.com" - -# API Token for the forge -# for gitlab this is a Personal Access Token -# https://gitlab.com/-/profile/personal_access_tokens -token = "HgDAfJ9tfD5xUw2L6SUm" - -# Directory to clone the repos into -directory = "/home/audron/repo/gitlab.com" -#+end_src - -* Known Problems -** error during git operation invalid or unknown remote ssh hostkey -libgit2, the git library this project uses, does not have support for ssh -configuration via ~\~/.ssh/config~. Thus if you have a custom location for the -~known_hosts~ file or disabled known hosts verification this configuration will -not be respected. - -Execute a ssh-keyscan to a known hosts file for each of your configured forges: -#+begin_src sh -ssh-keyscan gitlab.com >> ~/.ssh/known_hosts -#+end_src - -https://github.com/libgit2/libgit2/issues/4872 -- cgit v1.2.3