GitRoot

 1<!--
 2SPDX-FileCopyrightText: 2025 Romain Maneschi <romain@gitroot.dev>
 3
 4SPDX-License-Identifier: CC-BY-SA-4.0
 5-->
 6
 7# Install a plugin
 8
 9To install a plugin you can simply add the lines corresponding and GitRoot will install it.
10
11Open `.gitroot/plugins.yml` in the [root repository](../technicals/root_repository.md):
12
13```diff
14+- url: https://registry.com/path/to/plugin.wasm
15+  checksum: "sha256:0c755bb2dc5cc037216b29ba1709875afee425ee429b6be97f0d5e137067acff"
16```
17
18Commit your change and push `git add . && git commit -m "install ladybug plugin" && git push`. When the change will be in the [defaultBranch](../technicals/default_branch.md) GitRoot will copy it to their data. Then it will instantiate it and grab their default configuration.
19
20So after a `git pull` you should see:
21
22```diff
23 - url: url: https://registry.com/path/to/plugin.wasm
24   checksum: "sha256:0c755bb2dc5cc037216b29ba1709875afee425ee429b6be97f0d5e137067acff"
25+  name: ladybug
26+  active: false
27+  run:
28+  - path: issues/**/*.md
29+    branch:
30+    - "*"
31+    when:
32+    - add
33+    - mod
34+    write:
35+      git:
36+      - path: issues/**/*.md
37+        can:
38+        - mod
39+      web: []
40+    configuration:
41+      metadata:
42+      - default: autogenerated
43+        mandatory: true
44+        name: id
45+        type: crc16
46+      - default: 50.0
47+        mandatory: true
48+        name: priority
49+        type: int
50+      - default: null
51+        mandatory: false
52+        name: assignee
53+        type: user
54+      - default: triage
55+        mandatory: false
56+        name: status
57+        type: string
58+      - default: issue
59+        mandatory: false
60+        name: kind
61+        type: string
62```
63
64If you see that, congratulation, your plugin is correctly installed. GitRoot has pushed a commit with this configuation on all of the repositories of your instance.
65
66But don't panic, has you can see the plugin does nothing because it is inactive.
67
68Read more on [plugin rights](./plugin_rights.md) or [activate a plugin](./active_plugin.md).
69
70To find plugin URLs, checksums and more go on the [gitroot registry](../../plugins/index.md).