chore: v0.2.24

av · Jan 19, 2025 · 4efd335 · 4efd335
1 parent 48c39c5
commit 4efd335
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 14 deletions.
diff --git a/.scripts/seed.ts b/.scripts/seed.ts
@@ -2,7 +2,7 @@ import * as toml from 'jsr:@std/toml';
 import * as path from 'jsr:@std/path';
 import * as collections from "jsr:@std/collections/deep-merge";
 
-const VERSION = "0.2.23";
+const VERSION = "0.2.24";
 
 type ValueSeed = {
   // Path relative to the project root

diff --git a/RELEASE.md b/RELEASE.md
@@ -12,6 +12,12 @@ Includes:
 deno run -A ./.scripts/seed.ts
 ```
 
+### Sync docs to wiki
+
+```bash
+deno run -A ./.scripts/docs.ts
+```
+
 ### Publish to npm
 
 ```bash

diff --git a/app/package.json b/app/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@avcodes/harbor-app",
   "private": true,
-  "version": "0.2.23",
+  "version": "0.2.24",
   "type": "module",
   "scripts": {
     "dev": "vite",

diff --git a/app/src-tauri/Cargo.toml b/app/src-tauri/Cargo.toml
@@ -1,14 +1,14 @@
 
 [package]
 name = "harbor-app"
-version = "0.2.23"
+version = "0.2.24"
 description = "A companion app for Harbor LLM toolkit"
 authors = ["av"]
 edition = "2021"
 
 [lib]
 name = "harbor_lib"
-crate-type = ["staticlib", "cdylib", "rlib"]
+crate-type = ["staticlib","cdylib","rlib"]
 
 [build-dependencies.tauri-build]
 version = "2.0.3"

diff --git a/app/src-tauri/tauri.conf.json b/app/src-tauri/tauri.conf.json
@@ -1,7 +1,7 @@
 {
   "$schema": "https://schema.tauri.app/config/2.0.0-rc",
   "productName": "Harbor",
-  "version": "0.2.23",
+  "version": "0.2.24",
   "identifier": "com.harbor.app",
   "build": {
     "beforeDevCommand": "bun run dev",

diff --git a/docs/1.0.-Installing-Harbor.md b/docs/1.0.-Installing-Harbor.md
@@ -3,8 +3,8 @@
 > [!NOTE]
 > Harbor is still a young project (hence the 0.x.x versioning), installation and some features might not work as expected. Please report any issues you encounter.
 
+- [Requirements](#requirements)
 - [Harbor CLI](#harbor-cli)
-  - [Requirements](#requirements)
   - [Unsafe install](#unsafe-install)
   - [Manual install](#manual-install)
 - [Harbor App](#harbor-app)
@@ -14,16 +14,18 @@
     - [MacOS](#macos)
   - [MacOS Installation Issue](#macos-installation-issue)
 
-### Harbor CLI
+### Requirements
 
-#### Requirements
+Before installing Harbor's CLI or App, please go through below checklist line-by-line completing every step relevant to your platform and hardware.
 
 - On Windows - [enable WSL2](https://learn.microsoft.com/en-us/windows/wsl/install)
 - All Platforms - [install git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-- All platforms - [install Docker](https://docs.docker.com/engine/install/)
+- All Platforms - [install Docker](https://docs.docker.com/engine/install/)
   - On Linux - complete post-install for [`docker` without `sudo`](httpws://docs.docker.com/engine/install/linux-postinstall/)
-  - With Nvidia GPU - [install NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html#installation)
   - On Windows - [enable Docker in WSL2](https://docs.docker.com/desktop/wsl/#enabling-docker-support-in-wsl-2-distros)
+  - With Nvidia GPU - [install NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html#installation)
+    - Enables GPU pass-through for supported services
+    - On Windows - install the Container Toolkit under WSL2 following Linux instructions
 - All Platforms - [install Docker Compose plugin](https://docs.docker.com/compose/install/)
   - Harbor requires Docker Compose [2.23.1](https://docs.docker.com/compose/releases/release-notes/#2231) or newer
 - All Platforms - Bash-compatible shell 3.2 or newer
@@ -33,6 +35,10 @@
 > [!NOTE]
 > MacOS: some services do not ship ARM64 images. GPU pass-through is not supported on MacOS.
 
+Once the CLI is installed, you can also use [`harbor doctor`](./3.-Harbor-CLI-Reference#harbor-doctor) command to troubleshoot installation issues.
+
+### Harbor CLI
+
 #### Installation methods
 
 Harbor CLI can be installed in multiple ways that are listed below.
@@ -44,6 +50,8 @@ Harbor CLI can be installed in multiple ways that are listed below.
 
 #### Package Managers
 
+Please note that installation via package managers is experimental and might differ from the "native" installation via the script or manual method.
+
 **NPM**
 
 ```bash

diff --git a/docs/3.-Harbor-CLI-Reference.md b/docs/3.-Harbor-CLI-Reference.md
@@ -333,6 +333,16 @@ ls $(harbor home)
 ls $(harbor home)/ollama
 ```
 
+### `harbor doctor`
+
+Runs a diagnostic script to check if all requirements are met for Harbor to run properly.
+
+Will check things like relevant Docker and Docker Compose versions, the presence of required directories, and other things that might prevent Harbor CLI or the Harbor App running as expected.
+
+```bash
+harbor doctor
+```
+
 # Setup Management Commands
 
 ### `harbor ollama <command>`

diff --git a/harbor.sh b/harbor.sh
@@ -3890,7 +3890,7 @@ run_kobold_command() {
 # ========================================================================
 
 # Globals
-version="0.2.23"
+version="0.2.24"
 harbor_repo_url="https://github.com/av/harbor.git"
 harbor_release_url="https://api.github.com/repos/av/harbor/releases/latest"
 delimiter="|"

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@avcodes/harbor",
-  "version": "0.2.23",
+  "version": "0.2.24",
   "description": "Effortlessly run LLM backends, APIs, frontends, and services with one command.",
   "private": false,
   "author": "av <av@av.codes> (https://av.codes)",

diff --git a/pyproject.toml b/pyproject.toml