From 6867bae770a2fe180d358ca4196cc0fd1a118d47 Mon Sep 17 00:00:00 2001
From: Lena Tauchner <48085877+Tiefseetauchner@users.noreply.github.com>
Date: Wed, 28 Aug 2024 15:25:58 +0200
Subject: [PATCH] fix(cli): Update build instructions for CLI (#11874)
Update build instructions for CLI
---
cli/README.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/cli/README.md b/cli/README.md
index a570a55239..8fa2ace483 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -4,8 +4,18 @@ Please see the [Immich CLI documentation](https://immich.app/docs/features/comma
# For developers
+Before building the CLI, you must build the immich server and the open-api client. To build the server run the following in the server folder:
+
+ $ npm install
+ $ npm run build
+
+Then, to build the open-api client run the following in the open-api folder:
+
+ $ ./bin/generate-open-api.sh
+
To run the Immich CLI from source, run the following in the cli folder:
+ $ npm install
$ npm run build
$ ts-node .
@@ -17,3 +27,4 @@ You can also build and install the CLI using
$ npm run build
$ npm install -g .
+****