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:
12
13```diff
14+- url: /home/myuser/ladybug-0.0.1.wasm
15+  name: ladybug
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: /home/myuser/ladybug-0.0.1.wasm
24   name: ladybug
25+  active: false
26+  run:
27+  - path: issues/**/*.md
28+    branch:
29+    - "*"
30+    when:
31+    - add
32+    - mod
33+    write:
34+      git:
35+      - path: issues/**/*.md
36+        can:
37+        - mod
38+      web: []
39+    configuration:
40+      metadata:
41+      - default: autogenerated
42+        mandatory: true
43+        name: id
44+        type: crc16
45+      - default: 50.0
46+        mandatory: true
47+        name: priority
48+        type: int
49+      - default: null
50+        mandatory: false
51+        name: assignee
52+        type: user
53+      - default: triage
54+        mandatory: false
55+        name: status
56+        type: string
57+      - default: issue
58+        mandatory: false
59+        name: kind
60+        type: string
61```
62
63If 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.
64
65But don't panic, has you can see the plugin does nothing because it is inactive.
66
67Read more on [plugin rights](./plugin_rights.md).
68
69Or directly [activate a plugin](./active_plugin.md)