clementine-agent 1.0.7 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +35 -30
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -7,11 +7,15 @@
7
7
  ╚═════╝╚══════╝╚══════╝╚═╝ ╚═╝╚══════╝╚═╝ ╚═══╝ ╚═╝ ╚═╝╚═╝ ╚═══╝╚══════╝
8
8
  ```
9
9
 
10
- A persistent, ever-learning personal AI assistant that runs as a background daemon on macOS.
10
+ A persistent, ever-learning personal AI assistant that runs as a background daemon on macOS and Linux.
11
11
  Built on the [Claude Code SDK](https://docs.anthropic.com/en/docs/claude-code-sdk), Obsidian-compatible vault, and SQLite FTS5.
12
12
 
13
13
  Connects to Discord, Slack, Telegram, WhatsApp, and webhooks. Remembers everything. Runs 24/7.
14
14
 
15
+ **Requirements:** Node.js 20+ (22 recommended) · [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) authenticated · macOS or Linux.
16
+
17
+ **Contents:** [How it works](#how-it-works) · [Install](#install-recommended) · [Architecture](#architecture) · [CLI](#cli-reference) · [Configuration](#configuration) · [Channels](#channels) · [Agents & Teams](#agents--teams) · [Cron](#scheduled-tasks--cron-jobs) · [Unleashed mode](#unleashed-mode) · [Self-improvement](#self-improvement) · [Vault](#vault) · [Development](#development) · [Troubleshooting](#troubleshooting)
18
+
15
19
  ---
16
20
 
17
21
  ## How it works
@@ -63,45 +67,55 @@ The result: Clementine gets better the more you talk to it.
63
67
 
64
68
  ---
65
69
 
66
- ## Prerequisites
70
+ ## Install (recommended)
67
71
 
68
- - **Node.js 20-24 LTS** — `nvm install 22`
69
- - **Claude Code CLI** — already installed if you're reading this in Claude Code
72
+ Runtime: **Node.js 22 (recommended) or Node.js 20+**.
70
73
 
71
- ## Quick start
72
-
73
- **Option A — npm (recommended):**
74
74
  ```bash
75
- npm install -g clementine-agent
75
+ npm install -g clementine-agent@latest
76
76
  clementine setup
77
77
  ```
78
78
 
79
- **Option B — from source (for development):**
79
+ After setup:
80
+
80
81
  ```bash
81
- git clone https://github.com/Natebreynolds/Clementine-AI-Assistant.git clementine
82
- cd clementine
83
- bash install.sh
82
+ clementine launch # start as background daemon
83
+ clementine status # verify it's running
84
+ clementine dashboard # open the web command center
84
85
  ```
85
86
 
86
- The install script handles everything: system dependencies (redis, libomp, build tools), npm packages, TypeScript build, global CLI install, and launches the setup wizard. Safe to re-run — skips anything already installed.
87
+ Already installed? Update in place with `clementine update`.
87
88
 
88
- The setup wizard auto-generates a Discord bot invite URL from your token and offers to open it in your browser — no need to visit the Developer Portal manually.
89
+ ### Troubleshooting
89
90
 
90
- After setup:
91
+ **`EACCES: permission denied` on `npm install -g`.** Your Node was installed system-wide (`/usr/local/lib/...`) and npm can't write there without sudo. Fix it once, permanently:
91
92
 
92
93
  ```bash
93
- clementine launch # start as background daemon
94
- clementine status # verify it's running
95
- clementine dashboard # open the web command center
94
+ mkdir -p ~/.npm-global
95
+ npm config set prefix ~/.npm-global
96
+ echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.zshrc && source ~/.zshrc
97
+ npm install -g clementine-agent@latest
96
98
  ```
97
99
 
98
- Already have it? Update in place:
100
+ Or install Node via [nvm](https://github.com/nvm-sh/nvm) — user-scoped by default, no permission issues ever.
101
+
102
+ **`clementine: command not found` after install succeeded.** Run `npm config get prefix` — its `/bin` directory needs to be on your `PATH`. Add `export PATH="$(npm config get prefix)/bin:$PATH"` to your shell profile.
99
103
 
104
+ **Node version too old.** Install via nvm:
100
105
  ```bash
101
- clementine update
106
+ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
107
+ nvm install 22
108
+ ```
109
+
110
+ ### Install from source (for development)
111
+
112
+ ```bash
113
+ git clone https://github.com/Natebreynolds/Clementine-AI-Assistant.git clementine
114
+ cd clementine
115
+ bash install.sh
102
116
  ```
103
117
 
104
- That's it. Clementine is now running, connected to your configured channels, and learning.
118
+ Handles system dependencies (redis, libomp, build tools), npm packages, TypeScript build, global CLI install, and launches the setup wizard. Safe to re-run.
105
119
 
106
120
  ---
107
121
 
@@ -728,15 +742,6 @@ Key system files:
728
742
 
729
743
  ---
730
744
 
731
- ## Requirements
732
-
733
- - **Node.js 20-24 LTS** (for `--import` loader and `cpSync`)
734
- - **macOS** (Keychain integration, LaunchAgent — works on Linux without these)
735
- - **Claude Code CLI** installed and authenticated (`npm install -g @anthropic-ai/claude-code && claude login`)
736
- - No API key needed — authentication is handled by the Claude Code CLI
737
-
738
- ---
739
-
740
745
  ## Development
741
746
 
742
747
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "clementine-agent",
3
- "version": "1.0.7",
3
+ "version": "1.0.8",
4
4
  "description": "Clementine — Personal AI Assistant (TypeScript)",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",