aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 3d4bd10c04f760ff90cea497363a43b944528885 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#+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 <SUBCOMMAND> [SCOPE]

ARGS:
    <SCOPE>    Only operate on this subtree

OPTIONS:
    -h, --help           Print help information
    -j, --jobs <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