claude-self-reflect 2.2.1 → 2.3.0

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.
package/README.md CHANGED
@@ -13,11 +13,30 @@ Your conversations become searchable. Your decisions stay remembered. Your conte
13
13
 
14
14
  ## Install
15
15
 
16
+ ### Quick Start (Recommended)
16
17
  ```bash
17
- npm install -g claude-self-reflect && claude-self-reflect setup
18
+ # Step 1: Get your free Voyage AI key
19
+ # Sign up at https://www.voyageai.com/ - it takes 30 seconds
20
+
21
+ # Step 2: Install and run automatic setup
22
+ npm install -g claude-self-reflect
23
+ claude-self-reflect setup --voyage-key=YOUR_ACTUAL_KEY_HERE
24
+
25
+ # That's it! The setup will:
26
+ # ✅ Configure everything automatically
27
+ # ✅ Install the MCP in Claude Code
28
+ # ✅ Start monitoring for new conversations
29
+ # ✅ Verify the reflection tools work
18
30
  ```
19
31
 
20
- 5 minutes. That's it.
32
+ ### Alternative: Local Mode (No API Key)
33
+ ```bash
34
+ npm install -g claude-self-reflect
35
+ claude-self-reflect setup --local
36
+ ```
37
+ *Note: Local mode uses basic embeddings. Semantic search won't be as good.*
38
+
39
+ 5 minutes. Everything automatic. Just works.
21
40
 
22
41
  ## The Magic
23
42
 
@@ -104,10 +123,12 @@ Want to customize? See [Configuration Guide](docs/installation-guide.md).
104
123
  If you must know:
105
124
 
106
125
  - **Vector DB**: Qdrant (local, your data stays yours)
107
- - **Embeddings**: Voyage AI (200M free tokens/month)
126
+ - **Embeddings**: Voyage AI (200M free tokens/month)*
108
127
  - **MCP Server**: Python + FastMCP
109
128
  - **Search**: Semantic similarity with time decay
110
129
 
130
+ *We chose Voyage AI for their excellent cost-effectiveness ([66.1% accuracy at one of the lowest costs](https://research.aimultiple.com/embedding-models/#:~:text=Cost%2Deffective%20alternatives%3A%20Voyage%2D3.5%2Dlite%20delivered%20solid%20accuracy%20(66.1%25)%20at%20one%20of%20the%20lowest%20costs%2C%20making%20it%20attractive%20for%20budget%2Dsensitive%20implementations.)). We are not affiliated with Voyage AI.
131
+
111
132
  ### Want More Details?
112
133
 
113
134
  - [Architecture Deep Dive](docs/architecture-details.md) - How it actually works
@@ -121,6 +142,37 @@ If you must know:
121
142
  - [GitHub Issues](https://github.com/ramakay/claude-self-reflect/issues)
122
143
  - [Discussions](https://github.com/ramakay/claude-self-reflect/discussions)
123
144
 
145
+ ## Contributing
146
+
147
+ See our [Contributing Guide](CONTRIBUTING.md) for development setup and guidelines.
148
+
149
+ ### Releasing New Versions (Maintainers)
150
+
151
+ Since our GitHub Actions automatically publish to npm, the release process is simple:
152
+
153
+ ```bash
154
+ # 1. Ensure you're logged into GitHub CLI
155
+ gh auth login # Only needed first time
156
+
157
+ # 2. Create and push a new tag
158
+ git tag v2.3.0 # Use appropriate version number
159
+ git push origin v2.3.0
160
+
161
+ # 3. Create GitHub release (this triggers npm publish)
162
+ gh release create v2.3.0 \
163
+ --title "Release v2.3.0" \
164
+ --notes-file CHANGELOG.md \
165
+ --draft=false
166
+
167
+ # The GitHub Action will automatically:
168
+ # - Build the package
169
+ # - Run tests
170
+ # - Publish to npm
171
+ # - Update release assets
172
+ ```
173
+
174
+ Monitor the release at: https://github.com/ramakay/claude-self-reflect/actions
175
+
124
176
  ---
125
177
 
126
178
  Stop reading. Start installing. Your future self will thank you.
package/installer/cli.js CHANGED
@@ -18,7 +18,9 @@ async function setup() {
18
18
  console.log('🚀 Claude Self-Reflect Setup Wizard\n');
19
19
 
20
20
  const setupPath = join(__dirname, 'setup-wizard.js');
21
- const child = spawn('node', [setupPath], { stdio: 'inherit' });
21
+ // Pass along any command line arguments after 'setup'
22
+ const args = process.argv.slice(3); // Skip node, script, and 'setup'
23
+ const child = spawn('node', [setupPath, ...args], { stdio: 'inherit' });
22
24
 
23
25
  child.on('exit', (code) => {
24
26
  process.exit(code || 0);
@@ -95,13 +97,21 @@ async function doctor() {
95
97
 
96
98
  function help() {
97
99
  console.log('Claude Self-Reflect - Perfect memory for Claude\n');
98
- console.log('Usage: claude-self-reflect <command>\n');
100
+ console.log('Usage: claude-self-reflect <command> [options]\n');
99
101
  console.log('Commands:');
100
102
 
101
103
  for (const [cmd, desc] of Object.entries(commands)) {
102
104
  console.log(` ${cmd.padEnd(10)} ${desc}`);
103
105
  }
104
106
 
107
+ console.log('\nSetup Options:');
108
+ console.log(' --voyage-key=<key> Provide Voyage AI API key (recommended)');
109
+ console.log(' --local Run in local mode without API key');
110
+
111
+ console.log('\nExamples:');
112
+ console.log(' claude-self-reflect setup --voyage-key=pa-1234567890');
113
+ console.log(' claude-self-reflect setup --local');
114
+
105
115
  console.log('\nFor more information: https://github.com/ramakay/claude-self-reflect');
106
116
  }
107
117