esprit-cli 0.7.0 → 0.7.2

package/README.md

@@ -11,7 +11,7 @@ Esprit is an autonomous security assessment tool that uses AI agents to perform
 ### Option 1: Install with curl
 
 ```bash
-curl -fsSL https://esprit.dev/install.sh | bash
+curl -fsSL https://raw.githubusercontent.com/improdead/Esprit/main/scripts/install.sh | bash
 ```
 
 ### Option 2: Homebrew
@@ -24,7 +24,7 @@ brew install esprit
 ### Option 3: npm
 
 ```bash
-npm install -g @dekai/esprit
+npm install -g github:improdead/Esprit
 ```
 
 ### Option 4: From Source
@@ -38,6 +38,26 @@ poetry install
 
 ---
 
+## First-Run Onboarding
+
+On first use, Esprit opens a one-time onboarding wizard before any Docker checks.
+
+- Ghost-themed first-run setup flow
+- Guided setup for theme, providers, and preferred model
+- Skippable with reminder until completed
+
+After onboarding, run `esprit` to open the interactive launchpad UI.
+
+- Guided setup for target and scan mode
+- Unified theme across onboarding and scanning TUI
+- Local directory scan input with tab autocomplete
+
+```bash
+esprit
+```
+
+---
+
 ## Choose Your Setup
 
 Esprit supports two runtime modes depending on how you want to run scans.
@@ -153,6 +173,12 @@ esprit provider status             # Check all connected providers
 esprit provider logout <provider>  # Disconnect a provider
 ```
 
+OpenCode notes:
+
+- Public OpenCode models can be used without credentials when available on your machine.
+- If a public OpenCode model hits rate limits or upstream instability, Esprit auto-falls back to another healthy public model.
+- Recommended public models: `opencode/minimax-m2.5-free`, `opencode/kimi-k2.5-free`, `opencode/gpt-5-nano`.
+
 ---
 
 ## Configuration

package/bin/esprit.js

@@ -1,22 +1,32 @@
 #!/usr/bin/env node
 
 const fs = require("node:fs");
+const os = require("node:os");
 const path = require("node:path");
 const { spawnSync } = require("node:child_process");
 
 const isWindows = process.platform === "win32";
 const binaryName = isWindows ? "esprit.exe" : "esprit";
-const installDir = path.resolve(__dirname, "..", "npm", ".esprit-bin");
+const installDir = path.join(os.homedir(), ".esprit", "bin");
 const binaryPath = path.join(installDir, binaryName);
-const installerPath = path.resolve(__dirname, "..", "npm", "postinstall.mjs");
+const installerPath = path.resolve(__dirname, "..", "scripts", "install.sh");
 
 function ensureInstalled() {
   if (fs.existsSync(binaryPath)) {
     return;
   }
 
-  const bootstrap = spawnSync(process.execPath, [installerPath], {
+  if (isWindows) {
+    console.error("[esprit] installer currently supports macOS/Linux. Use WSL on Windows.");
+    process.exit(1);
+  }
+
+  const bootstrap = spawnSync("bash", [installerPath], {
     stdio: "inherit",
+    env: {
+      ...process.env,
+      ESPRIT_SKIP_DOCKER_WARM: process.env.ESPRIT_SKIP_DOCKER_WARM || "1",
+    },
   });
   if (bootstrap.status !== 0) {
     process.exit(bootstrap.status || 1);

package/npm/postinstall.mjs

@@ -1,126 +1,27 @@
 #!/usr/bin/env node
 
-import fs from "node:fs/promises";
 import path from "node:path";
-import os from "node:os";
 import { spawnSync } from "node:child_process";
 import { fileURLToPath } from "node:url";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
-const projectRoot = path.resolve(__dirname, "..");
-const packageJsonPath = path.join(projectRoot, "package.json");
-const installDir = path.join(projectRoot, "npm", ".esprit-bin");
-const repo = "improdead/Esprit";
+const installerPath = path.resolve(__dirname, "..", "scripts", "install.sh");
 
-function getTarget() {
-  let platform = os.platform();
-  let arch = os.arch();
-
-  if (platform === "darwin") {
-    platform = "macos";
-  } else if (platform === "linux") {
-    platform = "linux";
-  } else if (platform === "win32") {
-    platform = "windows";
-  } else {
-    throw new Error(`Unsupported platform: ${platform}`);
-  }
-
-  if (arch === "arm64") {
-    arch = "arm64";
-  } else if (arch === "x64") {
-    arch = "x86_64";
-  } else {
-    throw new Error(`Unsupported architecture: ${arch}`);
-  }
-
-  if (platform === "windows" && arch !== "x86_64") {
-    throw new Error(`Unsupported platform/arch: ${platform}/${arch}`);
-  }
-
-  return { platform, arch, target: `${platform}-${arch}` };
-}
-
-function buildAssetName(version, target) {
-  const ext = target.startsWith("windows-") ? ".zip" : ".tar.gz";
-  return `esprit-${version}-${target}${ext}`;
-}
-
-async function downloadFile(url, destPath) {
-  const response = await fetch(url);
-  if (!response.ok) {
-    throw new Error(`Download failed (${response.status}) ${url}`);
-  }
-  const arrayBuffer = await response.arrayBuffer();
-  await fs.writeFile(destPath, Buffer.from(arrayBuffer));
-}
-
-async function ensureDir(dir) {
-  await fs.mkdir(dir, { recursive: true });
-}
-
-function runCommand(command, args) {
-  const result = spawnSync(command, args, { stdio: "inherit" });
-  if (result.status !== 0) {
-    throw new Error(`Command failed: ${command} ${args.join(" ")}`);
-  }
+if (process.platform === "win32") {
+  process.stdout.write("[esprit] npm install currently supports macOS/Linux. Use WSL on Windows.\n");
+  process.exit(0);
 }
 
-function extractArchive(archivePath, extractDir) {
-  if (archivePath.endsWith(".zip")) {
-    if (process.platform === "win32") {
-      runCommand("powershell", [
-        "-NoProfile",
-        "-Command",
-        `Expand-Archive -Path "${archivePath}" -DestinationPath "${extractDir}" -Force`,
-      ]);
-    } else {
-      runCommand("unzip", ["-o", archivePath, "-d", extractDir]);
-    }
-    return;
-  }
-
-  runCommand("tar", ["-xzf", archivePath, "-C", extractDir]);
-}
-
-async function installBinary() {
-  const pkg = JSON.parse(await fs.readFile(packageJsonPath, "utf8"));
-  const version = process.env.ESPRIT_VERSION || pkg.version;
-  const { target } = getTarget();
-  const assetName = buildAssetName(version, target);
-  const downloadUrl = `https://github.com/${repo}/releases/download/v${version}/${assetName}`;
-
-  const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), "esprit-npm-"));
-  const archivePath = path.join(tempRoot, assetName);
-  const extractDir = path.join(tempRoot, "extract");
-  await ensureDir(extractDir);
-
-  try {
-    process.stdout.write(`[esprit] downloading ${assetName}\n`);
-    await downloadFile(downloadUrl, archivePath);
-    extractArchive(archivePath, extractDir);
-
-    const binaryName = target.startsWith("windows-") ? "esprit.exe" : "esprit";
-    const extractedPath = path.join(extractDir, binaryName);
-    await fs.access(extractedPath);
-
-    await ensureDir(installDir);
-    const outputPath = path.join(installDir, binaryName);
-    await fs.copyFile(extractedPath, outputPath);
-
-    if (!target.startsWith("windows-")) {
-      await fs.chmod(outputPath, 0o755);
-    }
+const result = spawnSync("bash", [installerPath], {
+  stdio: "inherit",
+  env: {
+    ...process.env,
+    // npm installs should be fast/predictable; sandbox image is pulled at first scan.
+    ESPRIT_SKIP_DOCKER_WARM: "1",
+  },
+});
 
-    await fs.writeFile(path.join(installDir, "VERSION"), `${version}\n`, "utf8");
-    process.stdout.write(`[esprit] installed ${binaryName}\n`);
-  } finally {
-    await fs.rm(tempRoot, { recursive: true, force: true });
-  }
+if (result.status !== 0) {
+  process.exit(result.status || 1);
 }
-
-installBinary().catch((error) => {
-  process.stderr.write(`[esprit] install failed: ${error.message}\n`);
-  process.exit(1);
-});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "esprit-cli",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "AI-powered penetration testing agent",
   "license": "Apache-2.0",
   "homepage": "https://esprit.dev",
@@ -17,6 +17,7 @@
   "files": [
     "bin",
     "npm",
+    "scripts",
     "README.md",
     "LICENSE"
   ],
@@ -26,4 +27,4 @@
   "engines": {
     "node": ">=18"
   }
-}
+}

package/scripts/build.sh

@@ -0,0 +1,98 @@
+#!/bin/bash
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
+
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+echo -e "${BLUE}Esprit Build Script${NC}"
+echo "================================"
+
+OS="$(uname -s)"
+ARCH="$(uname -m)"
+
+case "$OS" in
+    Linux*)     OS_NAME="linux";;
+    Darwin*)    OS_NAME="macos";;
+    MINGW*|MSYS*|CYGWIN*) OS_NAME="windows";;
+    *)          OS_NAME="unknown";;
+esac
+
+case "$ARCH" in
+    x86_64|amd64)   ARCH_NAME="x86_64";;
+    arm64|aarch64)  ARCH_NAME="arm64";;
+    *)              ARCH_NAME="$ARCH";;
+esac
+
+echo -e "${YELLOW}Platform:${NC} $OS_NAME-$ARCH_NAME"
+
+cd "$PROJECT_ROOT"
+
+if ! command -v poetry &> /dev/null; then
+    echo -e "${RED}Error: Poetry is not installed${NC}"
+    echo "Please install Poetry first: https://python-poetry.org/docs/#installation"
+    exit 1
+fi
+
+echo -e "\n${BLUE}Installing dependencies...${NC}"
+poetry install --with dev
+
+VERSION=$(poetry version -s)
+echo -e "${YELLOW}Version:${NC} $VERSION"
+
+echo -e "\n${BLUE}Cleaning previous builds...${NC}"
+rm -rf build/ dist/
+
+echo -e "\n${BLUE}Building binary with PyInstaller...${NC}"
+poetry run pyinstaller esprit.spec --noconfirm
+
+RELEASE_DIR="dist/release"
+mkdir -p "$RELEASE_DIR"
+
+BINARY_NAME="esprit-${VERSION}-${OS_NAME}-${ARCH_NAME}"
+
+if [ "$OS_NAME" = "windows" ]; then
+    if [ ! -f "dist/esprit.exe" ]; then
+        echo -e "${RED}Build failed: Binary not found${NC}"
+        exit 1
+    fi
+    BINARY_NAME="${BINARY_NAME}.exe"
+    cp "dist/esprit.exe" "$RELEASE_DIR/$BINARY_NAME"
+    echo -e "\n${BLUE}Creating zip...${NC}"
+    ARCHIVE_NAME="${BINARY_NAME%.exe}.zip"
+
+    if command -v 7z &> /dev/null; then
+        7z a "$RELEASE_DIR/$ARCHIVE_NAME" "$RELEASE_DIR/$BINARY_NAME"
+    else
+        powershell -Command "Compress-Archive -Path '$RELEASE_DIR/$BINARY_NAME' -DestinationPath '$RELEASE_DIR/$ARCHIVE_NAME'"
+    fi
+    echo -e "${GREEN}Created:${NC} $RELEASE_DIR/$ARCHIVE_NAME"
+else
+    if [ ! -f "dist/esprit" ]; then
+        echo -e "${RED}Build failed: Binary not found${NC}"
+        exit 1
+    fi
+    cp "dist/esprit" "$RELEASE_DIR/$BINARY_NAME"
+    chmod +x "$RELEASE_DIR/$BINARY_NAME"
+    echo -e "\n${BLUE}Creating tarball...${NC}"
+    ARCHIVE_NAME="${BINARY_NAME}.tar.gz"
+    tar -czvf "$RELEASE_DIR/$ARCHIVE_NAME" -C "$RELEASE_DIR" "$BINARY_NAME"
+    echo -e "${GREEN}Created:${NC} $RELEASE_DIR/$ARCHIVE_NAME"
+fi
+
+echo -e "\n${GREEN}Build successful!${NC}"
+echo "================================"
+echo -e "${YELLOW}Binary:${NC} $RELEASE_DIR/$BINARY_NAME"
+
+SIZE=$(ls -lh "$RELEASE_DIR/$BINARY_NAME" | awk '{print $5}')
+echo -e "${YELLOW}Size:${NC} $SIZE"
+
+echo -e "\n${BLUE}Testing binary...${NC}"
+"$RELEASE_DIR/$BINARY_NAME" --help > /dev/null 2>&1 && echo -e "${GREEN}Binary test passed!${NC}" || echo -e "${RED}Binary test failed${NC}"
+
+echo -e "\n${GREEN}Done!${NC}"

package/scripts/install.sh

@@ -0,0 +1,253 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+APP="esprit"
+REPO_URL="${ESPRIT_REPO_URL:-https://github.com/improdead/Esprit.git}"
+REPO_REF="${ESPRIT_REPO_REF:-main}"
+INSTALL_ROOT="${ESPRIT_HOME:-$HOME/.esprit}"
+BIN_DIR="$INSTALL_ROOT/bin"
+RUNTIME_DIR="$INSTALL_ROOT/runtime"
+VENV_DIR="$INSTALL_ROOT/venv"
+LAUNCHER_PATH="$BIN_DIR/$APP"
+ESPRIT_IMAGE="${ESPRIT_IMAGE:-improdead/esprit-sandbox:latest}"
+
+MUTED='\033[0;2m'
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+CYAN='\033[0;36m'
+NC='\033[0m'
+
+FORCE=false
+for arg in "$@"; do
+  case "$arg" in
+    --force|-f) FORCE=true ;;
+  esac
+done
+
+print_message() {
+  local level="$1"
+  local message="$2"
+  local color="$NC"
+  case "$level" in
+    success) color="$GREEN" ;;
+    warning) color="$YELLOW" ;;
+    error) color="$RED" ;;
+  esac
+  echo -e "${color}${message}${NC}"
+}
+
+require_command() {
+  local cmd="$1"
+  local install_hint="$2"
+  if ! command -v "$cmd" >/dev/null 2>&1; then
+    print_message error "Missing required command: $cmd"
+    print_message info "$install_hint"
+    exit 1
+  fi
+}
+
+choose_python() {
+  local candidate
+  for candidate in python3.13 python3.12 python3; do
+    if ! command -v "$candidate" >/dev/null 2>&1; then
+      continue
+    fi
+
+    if "$candidate" - <<'PY' >/dev/null 2>&1
+import sys
+raise SystemExit(0 if sys.version_info >= (3, 12) else 1)
+PY
+    then
+      echo "$candidate"
+      return 0
+    fi
+  done
+
+  return 1
+}
+
+sync_runtime_repo() {
+  print_message info "${MUTED}Syncing Esprit runtime source...${NC}"
+
+  if [ -d "$RUNTIME_DIR/.git" ]; then
+    git -C "$RUNTIME_DIR" remote set-url origin "$REPO_URL"
+    git -C "$RUNTIME_DIR" fetch --depth 1 origin "$REPO_REF"
+    git -C "$RUNTIME_DIR" checkout -q FETCH_HEAD
+  else
+    rm -rf "$RUNTIME_DIR"
+    git clone --depth 1 --branch "$REPO_REF" "$REPO_URL" "$RUNTIME_DIR"
+  fi
+
+  local runtime_commit
+  runtime_commit=$(git -C "$RUNTIME_DIR" rev-parse --short HEAD 2>/dev/null || echo "unknown")
+  print_message success "✓ Runtime ready (${runtime_commit})"
+}
+
+install_python_runtime() {
+  local py_bin="$1"
+
+  mkdir -p "$INSTALL_ROOT"
+  if [ "$FORCE" = true ] || [ ! -x "$VENV_DIR/bin/python" ]; then
+    print_message info "${MUTED}Creating virtual environment...${NC}"
+    rm -rf "$VENV_DIR"
+    "$py_bin" -m venv "$VENV_DIR"
+  fi
+
+  print_message info "${MUTED}Installing Esprit dependencies (this can take a few minutes)...${NC}"
+  "$VENV_DIR/bin/python" -m pip install --upgrade pip setuptools wheel >/dev/null
+  "$VENV_DIR/bin/pip" install --upgrade "$RUNTIME_DIR" >/dev/null
+  print_message success "✓ Python runtime installed"
+}
+
+write_launcher() {
+  mkdir -p "$BIN_DIR"
+
+  cat > "$LAUNCHER_PATH" <<'EOF'
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT="${ESPRIT_HOME:-$HOME/.esprit}"
+BIN="$ROOT/venv/bin/esprit"
+
+if [ ! -x "$BIN" ]; then
+  echo "Esprit runtime not found. Re-run the installer."
+  exit 1
+fi
+
+exec "$BIN" "$@"
+EOF
+
+  chmod 755 "$LAUNCHER_PATH"
+  print_message success "✓ Installed launcher at $LAUNCHER_PATH"
+}
+
+setup_path() {
+  local shell_name
+  shell_name=$(basename "${SHELL:-sh}")
+
+  local config_file=""
+  case "$shell_name" in
+    zsh)
+      config_file="${ZDOTDIR:-$HOME}/.zshrc"
+      ;;
+    bash)
+      config_file="$HOME/.bashrc"
+      ;;
+    fish)
+      config_file="$HOME/.config/fish/config.fish"
+      ;;
+    *)
+      config_file="$HOME/.profile"
+      ;;
+  esac
+
+  if [ "$shell_name" = "fish" ]; then
+    local line="fish_add_path $BIN_DIR"
+    if [ -f "$config_file" ] && grep -Fxq "$line" "$config_file" 2>/dev/null; then
+      return
+    fi
+    if [ ! -f "$config_file" ]; then
+      mkdir -p "$(dirname "$config_file")"
+      touch "$config_file"
+    fi
+    echo "" >> "$config_file"
+    echo "# esprit" >> "$config_file"
+    echo "$line" >> "$config_file"
+    print_message info "${MUTED}Added esprit to PATH in ${NC}$config_file"
+    return
+  fi
+
+  local export_line="export PATH=$BIN_DIR:\$PATH"
+  if [ -f "$config_file" ] && grep -Fxq "$export_line" "$config_file" 2>/dev/null; then
+    return
+  fi
+
+  if [ ! -f "$config_file" ]; then
+    touch "$config_file"
+  fi
+  if [ -w "$config_file" ]; then
+    echo "" >> "$config_file"
+    echo "# esprit" >> "$config_file"
+    echo "$export_line" >> "$config_file"
+    print_message info "${MUTED}Added esprit to PATH in ${NC}$config_file"
+  else
+    print_message warning "Could not update $config_file automatically."
+    print_message info "Add this line manually: $export_line"
+  fi
+}
+
+warm_docker_image() {
+  if [ "${ESPRIT_SKIP_DOCKER_WARM:-0}" = "1" ]; then
+    return
+  fi
+
+  if ! command -v docker >/dev/null 2>&1; then
+    print_message warning "Docker not found (required for local/provider scans)."
+    print_message info "Esprit Cloud scans still work without Docker."
+    return
+  fi
+
+  if ! docker info >/dev/null 2>&1; then
+    print_message warning "Docker daemon is not running."
+    print_message info "Start Docker for local/provider scans."
+    return
+  fi
+
+  print_message info "${MUTED}Pulling sandbox image (optional warm-up)...${NC}"
+  local pull_output
+  local pull_status=0
+  pull_output="$(docker pull "$ESPRIT_IMAGE" 2>&1)" || pull_status=$?
+
+  if [ "$pull_status" -eq 0 ]; then
+    print_message success "✓ Sandbox image ready"
+    return
+  fi
+
+  echo -e "$pull_output"
+
+  if [[ "$(uname -m)" == "arm64" ]] && echo "$pull_output" | grep -qi "no matching manifest" && echo "$pull_output" | grep -qi "arm64"; then
+    print_message warning "Native arm64 image missing; retrying with linux/amd64 emulation..."
+    if docker pull --platform linux/amd64 "$ESPRIT_IMAGE" >/dev/null; then
+      print_message success "✓ Sandbox image ready (linux/amd64 emulation)"
+      return
+    fi
+  fi
+
+  print_message warning "Sandbox pull skipped (will retry at first local scan)."
+}
+
+main() {
+  require_command git "Install git and re-run the installer."
+  require_command curl "Install curl and re-run the installer."
+
+  local py_bin
+  py_bin=$(choose_python || true)
+  if [ -z "$py_bin" ]; then
+    print_message error "Python 3.12+ is required."
+    print_message info "Install Python 3.12 and re-run this installer."
+    exit 1
+  fi
+
+  print_message info "${CYAN}Installing Esprit${NC} ${MUTED}(source mode)${NC}"
+  print_message info "${MUTED}Runtime source:${NC} $REPO_URL@$REPO_REF"
+  print_message info "${MUTED}Install root:${NC} $INSTALL_ROOT"
+
+  sync_runtime_repo
+  install_python_runtime "$py_bin"
+  write_launcher
+  setup_path
+  warm_docker_image
+
+  local version
+  version=$("$LAUNCHER_PATH" --version 2>/dev/null || echo "unknown")
+  print_message success "✓ ${version} ready"
+
+  echo ""
+  echo -e "${MUTED}Run this now (or open a new terminal):${NC}"
+  echo -e "  ${MUTED}export PATH=$BIN_DIR:\$PATH${NC}"
+  echo -e "  ${MUTED}$APP --help${NC}"
+}
+
+main