fegger
378642152e
- manifest.json: fix 'main' from 'src/main.js' to 'dist/main.js' (TypeScript compiles to dist/, not src/ — Obsidian could not find the entry point) - manifest.json: set isDesktopOnly to true (plugin requires a local Ollama server) - package.json: remove unused node-fetch dependency (ESM-only, conflicts with CommonJS build) - src/semantic-cache.ts: use dynamic import for chromadb instead of top-level import (prevents plugin load crash when chromadb is not installed; cache defaults to disabled) - install.sh: new script that installs deps, builds, and copies the plugin into a vault - README.md: add quick install, manual install, and expanded troubleshooting sections
134 lines
4.7 KiB
Bash
Executable File
134 lines
4.7 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# install.sh — Install the Ollama Plugin into an Obsidian vault
|
|
#
|
|
# Usage:
|
|
# ./install.sh /path/to/your/vault
|
|
#
|
|
# The script will:
|
|
# 1. Install npm dependencies (excluding Ollama itself — you need that separately)
|
|
# 2. Compile the TypeScript plugin
|
|
# 3. Copy the built plugin into <vault>/.obsidian/plugins/ollama-plugin/
|
|
#
|
|
# Prerequisites:
|
|
# - Node.js and npm
|
|
# - Ollama installed and running (https://ollama.ai)
|
|
#
|
|
|
|
set -euo pipefail
|
|
|
|
# ── Helpers ──────────────────────────────────────────────────────────────────
|
|
|
|
RED='\033[0;31m'
|
|
GREEN='\033[0;32m'
|
|
YELLOW='\033[1;33m'
|
|
BOLD='\033[1m'
|
|
NC='\033[0m' # No Color
|
|
|
|
info() { printf "${GREEN}→${NC} %s\n" "$1"; }
|
|
warn() { printf "${YELLOW}⚠${NC} %s\n" "$1"; }
|
|
error() { printf "${RED}✗${NC} %s\n" "$1"; }
|
|
step() { printf "\n${BOLD}══ %s ══${NC}\n" "$1"; }
|
|
|
|
# ── Argument validation ──────────────────────────────────────────────────────
|
|
|
|
VAULT_PATH="${1:-}"
|
|
|
|
if [ -z "$VAULT_PATH" ]; then
|
|
echo "Usage: ./install.sh /path/to/your/vault"
|
|
echo ""
|
|
echo " Provide the path to your Obsidian vault directory."
|
|
echo " The plugin will be installed into <vault>/.obsidian/plugins/ollama-plugin/"
|
|
exit 1
|
|
fi
|
|
|
|
if [ ! -d "$VAULT_PATH" ]; then
|
|
error "Vault directory does not exist: $VAULT_PATH"
|
|
exit 1
|
|
fi
|
|
|
|
if [ ! -d "$VAULT_PATH/.obsidian" ]; then
|
|
warn "No .obsidian folder found in $VAULT_PATH — this may not be a valid Obsidian vault."
|
|
warn "Continuing anyway, but the plugin may not load."
|
|
fi
|
|
|
|
PLUGIN_DIR="$VAULT_PATH/.obsidian/plugins/ollama-plugin"
|
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
|
|
|
# ── Check prerequisites ──────────────────────────────────────────────────────
|
|
|
|
step "Checking prerequisites"
|
|
|
|
if ! command -v node &> /dev/null; then
|
|
error "Node.js is required but not found. Install it from https://nodejs.org"
|
|
exit 1
|
|
fi
|
|
info "Node.js $(node --version)"
|
|
|
|
if ! command -v npm &> /dev/null; then
|
|
error "npm is required but not found."
|
|
exit 1
|
|
fi
|
|
info "npm $(npm --version)"
|
|
|
|
# ── Install dependencies ─────────────────────────────────────────────────────
|
|
|
|
step "Installing npm dependencies"
|
|
|
|
cd "$SCRIPT_DIR"
|
|
npm install --production
|
|
info "Dependencies installed"
|
|
|
|
# ── Build ────────────────────────────────────────────────────────────────────
|
|
|
|
step "Building the plugin"
|
|
|
|
npm run build
|
|
info "Build complete"
|
|
|
|
# ── Install into vault ───────────────────────────────────────────────────────
|
|
|
|
step "Installing into vault"
|
|
|
|
mkdir -p "$PLUGIN_DIR"
|
|
|
|
# Copy manifest and built output
|
|
cp "$SCRIPT_DIR/manifest.json" "$PLUGIN_DIR/"
|
|
cp -r "$SCRIPT_DIR/dist" "$PLUGIN_DIR/"
|
|
|
|
# Copy only necessary runtime dependencies (obsidian and chromadb stubs)
|
|
# The obsidian package is only used for type definitions at build time —
|
|
# at runtime Obsidian provides its own API, so we don't need it in node_modules.
|
|
# chromadb is loaded dynamically and only needed when the cache is enabled.
|
|
mkdir -p "$PLUGIN_DIR/node_modules"
|
|
if [ -d "$SCRIPT_DIR/node_modules/chromadb" ]; then
|
|
cp -r "$SCRIPT_DIR/node_modules/chromadb" "$PLUGIN_DIR/node_modules/"
|
|
fi
|
|
|
|
info "Plugin installed to $PLUGIN_DIR"
|
|
|
|
# ── Verify ────────────────────────────────────────────────────────────────────
|
|
|
|
step "Verifying installation"
|
|
|
|
if [ -f "$PLUGIN_DIR/manifest.json" ] && [ -f "$PLUGIN_DIR/dist/main.js" ]; then
|
|
info "manifest.json ✓"
|
|
info "dist/main.js ✓"
|
|
else
|
|
error "Installation verification failed — missing files in $PLUGIN_DIR"
|
|
exit 1
|
|
fi
|
|
|
|
echo ""
|
|
echo " ${GREEN}${BOLD}Done!${NC} The plugin has been installed."
|
|
echo ""
|
|
echo " Next steps:"
|
|
echo " 1. Restart Obsidian (or reload plugins: Ctrl+Shift+P → 'Reload app without saving')"
|
|
echo " 2. Go to Settings → Community plugins → enable 'Ollama Plugin'"
|
|
echo " 3. Configure the plugin: Settings → Ollama Settings"
|
|
echo ""
|
|
echo " Make sure Ollama is running:"
|
|
echo " ollama serve"
|
|
echo " ollama pull llama3 (or your preferred model)"
|
|
echo ""
|