Install a local checkout

finos · Jul 17, 2024 · 2a852c9 · 2a852c9
1 parent 9aaf885
commit 2a852c9
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/website/docs/installation.mdx b/website/docs/installation.mdx
@@ -30,3 +30,17 @@ To install a specific version of the GitProxy CLI, append the version to the end
 ```bash
 npm install -g @finos/[email protected]
 ```
+
+### Install a local checkout
+
+To test a personal fork, or the latest version of the main branch:
+
+```bash
+git clone [email protected]:finos/git-proxy.git
+cd git-proxy
+npm pack
+npm i -g finos-git-proxy-<version>.tar.gz
+git-proxy --version
+```
+
+To make sure that the `git-proxy` command is using your checked out version, update the `version` in `package.json` before running `npm pack`, then verify that the same version is returned when running `git-proxy --version`.