vivream 0.1.0 → 0.1.1

package/README.md

@@ -2,7 +2,7 @@
 
 **Brain-dump in. Blueprint out.**
 
-A local AI workbench that turns your raw ideas into structured plans — powered by your own Claude Code, Codex, or Agy CLI. No cloud account needed. Completely free.
+A free, local-first AI workbench that turns your raw ideas into structured plans — powered by your own Claude Code, Codex, or Agy CLI. No subscription. No cloud. Everything runs on your machine.
 
 [![npm](https://img.shields.io/npm/v/vivream)](https://www.npmjs.com/package/vivream)
 [![GitHub Sponsors](https://img.shields.io/github/sponsors/AppSoApp?label=Sponsor&logo=githubsponsors)](https://github.com/sponsors/AppSoApp)
@@ -18,22 +18,105 @@ npx vivream
 
 Opens automatically at `http://localhost:3001`.
 
+---
+
 ## Requirements
 
-- **Node.js ≥ 20**
-- One of the following AI runtimes:
-  - [Claude Code](https://claude.ai/code) (recommended)
-  - [OpenAI Codex CLI](https://github.com/openai/codex)
-  - [Agy](https://github.com/antigravityai/agy)
-  - **Or** enter a BYOK API key inside the app under Settings
+- **Node.js ≥ 20** ([nodejs.org](https://nodejs.org))
+- One AI runtime (pick one):
+
+| Runtime | How to get it |
+|---|---|
+| **Claude Code** (recommended) | [claude.ai/code](https://claude.ai/code) |
+| **OpenAI Codex CLI** | `npm install -g @openai/codex` |
+| **Agy** | [antigravity.ai](https://antigravity.ai) |
+| **BYOK API Key** | Enter inside the app under Settings → BYOK |
+
+---
+
+## Installation by OS
+
+### Windows
+
+1. Install Node.js from [nodejs.org](https://nodejs.org) (LTS version)
+2. Open **PowerShell** or **Command Prompt**
+3. Run:
+```
+npx vivream
+```
+4. Browser opens automatically at `http://localhost:3001`
+
+> If `npx` is not found, restart the terminal after installing Node.js.
+
+### macOS
+
+1. Install Node.js:
+```bash
+brew install node
+# or download from nodejs.org
+```
+2. Open **Terminal** and run:
+```bash
+npx vivream
+```
+3. Browser opens automatically at `http://localhost:3001`
+
+### Linux
+
+```bash
+# Install Node.js 20+ (if not already installed)
+curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
+sudo apt-get install -y nodejs
+
+# Run Vivream
+npx vivream
+```
+
+---
 
 ## How It Works
 
-1. Brain-dump your thoughts into the entry box
-2. Let the AI organize them into a structured plan
-3. Save sessions, compare ideas, and generate pitch decks
+1. **Brain-dump** — Type your raw ideas, notes, or goals into the input box. No structure needed.
+2. **Generate** — AI organizes your dump into a structured document, mindmap, prompt, or pitch deck.
+3. **Save sessions** — Save your sessions and revisit them later.
+4. **Time Machine** — Roll back to any previous checkpoint in your session.
+5. **Cross-Pollination** — Vivream finds similar past sessions and suggests connections automatically.
+
+All AI processing happens on your machine using your own credentials. No data is sent to Vivream servers.
+
+---
+
+## Settings
+
+### BYOK (Bring Your Own Key)
+If you don't have Claude Code / Codex / Agy installed, you can use an API key directly:
+
+1. Open `http://localhost:3001`
+2. Go to **Settings → BYOK**
+3. Enter your Anthropic API key
+
+Get an API key at [console.anthropic.com](https://console.anthropic.com)
+
+### Port
+Default port is `3001`. If it's in use, Vivream automatically tries the next available port.
+
+---
 
-All processing happens on your machine using your own AI credentials. No data leaves your device.
+## Troubleshooting
+
+**"No local AI CLI detected"**  
+→ Install Claude Code, Codex CLI, or Agy — or add a BYOK API key in Settings.
+
+**Browser doesn't open automatically**  
+→ Navigate to `http://localhost:3001` manually.
+
+**Port already in use**  
+→ Vivream will automatically find the next free port. Check the terminal output for the actual URL.
+
+**First run is slow**  
+→ The first run extracts the server bundle (~13MB) to `~/.vivream/cache/`. Subsequent runs start instantly.
+
+---
 
 ## Support Development
 
@@ -42,6 +125,8 @@ Vivream is free and open to use. If it saves you time, consider sponsoring:
 - [GitHub Sponsors](https://github.com/sponsors/AppSoApp)
 - [Ko-fi](https://ko-fi.com/appsoapplication)
 
+---
+
 ## Contact
 
 appsoapplication@gmail.com · [Issues](https://github.com/AppSoApp/Vivream/issues)
@@ -54,9 +139,9 @@ MIT
 
 ## 한국어
 
-**두뇌 덤프 → 블루프린트 완성.**
+**아이디어를 쏟아내세요. 설계도로 바꿔드립니다.**
 
-내 Claude Code / Codex / Agy CLI 로 구동되는 로컬 AI 워크벤치. 클라우드 계정 불필요. 완전 무료.
+Claude Code / Codex / Agy CLI 로 구동되는 무료 로컬 AI 워크벤치. 구독 없음. 클라우드 없음. 내 컴퓨터에서 전부 실행.
 
 ### 시작하기
 
@@ -68,16 +153,42 @@ npx vivream
 
 ### 필요 사항
 
-- **Node.js ≥ 20**
-- 아래 중 하나의 AI 런타임:
-  - [Claude Code](https://claude.ai/code) (권장)
-  - [OpenAI Codex CLI](https://github.com/openai/codex)
-  - [Agy](https://github.com/antigravityai/agy)
-  - 또는 앱 내 설정에서 BYOK API 키 입력
+- **Node.js ≥ 20** ([nodejs.org](https://nodejs.org))
+- 아래 중 하나:
+  - **Claude Code** (권장) — [claude.ai/code](https://claude.ai/code)
+  - **OpenAI Codex CLI** — `npm install -g @openai/codex`
+  - **Agy**
+  - **BYOK** — 앱 내 설정 → BYOK에서 API 키 입력
 
-### 후원
+### 설치 방법
+
+**Windows**
+1. [nodejs.org](https://nodejs.org)에서 Node.js 설치
+2. PowerShell 또는 명령 프롬프트 열기
+3. `npx vivream` 실행
+
+**macOS**
+```bash
+brew install node
+npx vivream
+```
 
-Vivream 은 무료입니다. 도움이 됐다면 후원을 고려해 주세요:
+**Linux**
+```bash
+curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
+sudo apt-get install -y nodejs
+npx vivream
+```
+
+### 사용법
+
+1. **입력창에 아이디어 덤프** — 형식 없이 자유롭게 입력
+2. **생성 버튼 클릭** — AI가 문서/마인드맵/프롬프트/피치덱으로 정리
+3. **세션 저장** — 이전 작업 저장 및 재방문
+4. **Time Machine** — 이전 체크포인트로 롤백
+5. **Cross-Pollination** — 과거 유사 세션 자동 추천
+
+### 후원
 
 - [GitHub Sponsors](https://github.com/sponsors/AppSoApp)
 - [Ko-fi](https://ko-fi.com/appsoapplication)

package/bin/cli.js

@@ -6,6 +6,7 @@ const path = require('path');
 const net = require('net');
 const os = require('os');
 const fs = require('fs');
+const tar = require('tar');
 
 const PKG_ROOT = path.join(__dirname, '..');
 const PKG_JSON = require(path.join(PKG_ROOT, 'package.json'));
@@ -39,7 +40,7 @@ const MSG = {
     : '  Failed to extract bundle. Try reinstalling: npm install -g vivream',
 };
 
-function ensureExtracted() {
+async function ensureExtracted() {
   if (fs.existsSync(SERVER_PATH)) return;
   if (!fs.existsSync(BUNDLE_PATH)) {
     process.stderr.write(MSG.extractError + '\n');
@@ -47,8 +48,9 @@ function ensureExtracted() {
   }
   process.stdout.write(MSG.extracting + '\n');
   fs.mkdirSync(CACHE_DIR, { recursive: true });
-  const result = spawnSync('tar', ['-xzf', BUNDLE_PATH, '-C', CACHE_DIR], { stdio: 'inherit' });
-  if (result.status !== 0) {
+  try {
+    await tar.extract({ file: BUNDLE_PATH, cwd: CACHE_DIR });
+  } catch (e) {
     process.stderr.write(MSG.extractError + '\n');
     process.exit(1);
   }
@@ -80,7 +82,7 @@ function cliExists(name) {
 }
 
 async function main() {
-  ensureExtracted();
+  await ensureExtracted();
 
   if (!['claude', 'codex', 'agy'].some(cliExists)) {
     process.stderr.write(MSG.noCli);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vivream",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Brain-dump in. Blueprint out. — Local AI workbench powered by your own Claude / Codex / Agy CLI",
   "keywords": ["ai", "claude", "brain-dump", "workbench", "local-first", "mindmap", "prompt"],
   "homepage": "https://github.com/AppSoApp/Vivream",
@@ -20,6 +20,9 @@
     "bin/",
     "vivream-server.tar.gz"
   ],
+  "dependencies": {
+    "tar": "^6"
+  },
   "engines": {
     "node": ">=20.0.0"
   },