@principle2026/vault 1.0.0 → 1.0.2

package/README.md

@@ -1,117 +1,138 @@
-# Vault — AI-Powered Secret Management
+# Vault — AI-Powered Secret Management for Claude Code
 
-A Claude Code plugin that enables AI to automatically manage your secrets and sensitive information.
+一个 Claude Code 技能，让 AI 帮你安全地管理 API 密钥、密码等敏感信息。
 
-## Features
+## 特点
 
-- 🗣️ **Conversational** — Save and retrieve secrets using natural language
-- 🔐 **End-to-end encryption** — AES-256-GCM encryption
-- ☁️ **iCloud sync** — Automatically sync across all your devices
-- 🔑 **Keychain integration** — Secure master key storage
-- ⚡ **Zero config** — Ready to use after initialization
+- 🗣️ **对话式操作** — 用自然语言保存和获取密钥
+- 🔐 **端到端加密** — AES-256-GCM 加密
+- ☁️ **iCloud 同步** — 自动同步到所有设备（macOS）
+- 🔑 **Keychain 集成** - 安全存储主密钥
+- ⚡ **零配置** — 安装后立即可用
 
-## Installation
+---
 
-### 方式 1: npm 全局安装（推荐）
+## 安装
+
+### 一键安装（推荐）
 
 ```bash
 npm install -g @principle2026/vault
 vault init
 ```
 
-### 方式 2: 本地开发
+安装脚本会自动：
+- 安装 CLI 命令
+- 创建 Claude Code 技能链接
+- 引导你完成首次设置
+
+### 手动安装 Claude Code 技能
 
 ```bash
-git clone <repository>
-cd Vault
-npm install
-npm run build
-```
+# 1. 安装 npm 包
+npm install -g @principle2026/vault
 
-## Usage
+# 2. 找到安装位置
+npm root -g
+# 输出: /usr/local/lib/node_modules （或其他路径）
 
-### Initialize
+# 3. 创建技能链接
+ln -s $(npm root -g)/@principle2026/vault ~/.claude/skills/vault
 
-```bash
+# 4. 初始化
 vault init
 ```
 
-Follow the interactive prompts to set up your master passphrase.
+---
 
-### Save a secret
+## 在 Claude Code 中使用
 
-```bash
-echo "sk-abc123" | vault set openai_key --description "OpenAI API Key"
-```
+安装后，直接和 AI 对话：
 
-### Get a secret
+### 保存密钥
 
-```bash
-vault get openai_key
+```
+你：记住我的 OpenAI 密钥是 sk-abc123
+AI：✅ 已保存：openai_key
 ```
 
-### List secrets
-
-```bash
-vault list
+```
+你：保存这个 GitHub token: ghp_xxx123
+AI：[运行: vault set github_token --description "GitHub Token"]
+    ✅ Saved: github_token
 ```
 
-### Delete a secret
+### 获取密钥
 
-```bash
-vault delete openai_key
+```
+你：用刚才保存的 token 创建一个 GitHub repo
+AI：好的，使用你保存的 GitHub token...
+    [运行: vault get github_token]
+    → 正在创建仓库...
 ```
 
-### Check status
+```
+你：我的 OpenAI 密钥是什么？
+AI：[运行: vault get openai_key]
+    sk-abc123
+```
+
+### 查看所有密钥
 
-```bash
-vault status
+```
+你：我保存了哪些密钥？
+AI：[运行: vault list]
+    📋 已保存的密钥：
+    - openai_key - OpenAI API Key
+    - github_token - GitHub Token
 ```
 
-## AI Conversation Usage
+### AI 自动识别的关键词
 
-In Claude Code, use natural language:
+| 你说 | AI 做 |
+|------|------|
+| "记住/保存/存储..." | 保存密钥 |
+| "那个密钥/我的密码/刚才的..." | 获取密钥 |
+| "有哪些/列出/查看..." | 显示密钥列表 |
+| "删除..." | 删除密钥 |
 
-```
-You: Remember my OpenAI key is sk-abc123
-AI: [auto-save] Saved: openai_key
+---
 
-You: Use that key to call the API
-AI: [auto-retrieve] Using sk-abc123...
-```
+## CLI 命令（手动使用）
 
-## Security Design
+```bash
+# 查看状态
+vault status
 
-- **Algorithm**: AES-256-GCM
-- **Key derivation**: PBKDF2 (100,000 iterations)
-- **Storage**: iCloud or local `~/.vault-data/`
-- **Master key**: System keychain (unlocked by passphrase)
+# 保存密钥
+vault set <key>
+# 或：echo "value" | vault set <key> -d "描述"
 
-## Project Structure
+# 获取密钥
+vault get <key>
 
-```
-src/
-├── Crypto.ts   # Encryption/decryption
-├── Keychain.ts # Keychain operations
-├── Store.ts    # Data storage
-├── tools.ts    # Core functions
-└── index.ts    # CLI entry point
+# 列出所有密钥
+vault list
+
+# 删除密钥
+vault delete <key>
+
+# 重置（删除所有数据）
+vault reset
 ```
 
-## Development
+---
 
-```bash
-# Build
-npm run build
+## 安全设计
 
-# Watch mode
-npm run dev
+- **加密算法**: AES-256-GCM
+- **密钥派生**: PBKDF2 (100,000 次迭代)
+- **存储位置**: iCloud（macOS）或本地 `~/.vault-data/`
+- **主密钥**: 系统 Keychain（受密码保护）
 
-# Run CLI
-./dist/index.js status
-```
+---
 
-## Dependencies
+## 项目地址
 
-- `keytar` — Keychain access
-- Web Crypto API — Encryption operations
+- npm: https://www.npmjs.com/package/@principle2026/vault
+- GitHub: https://github.com/xiaolin26/vault

package/dist/postinstall.d.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env bun
+/**
+ * Post-install script
+ * Automatically creates Claude Code skill link after npm install
+ */
+export {};
+//# sourceMappingURL=postinstall.d.ts.map

package/dist/postinstall.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postinstall.d.ts","sourceRoot":"","sources":["../src/postinstall.ts"],"names":[],"mappings":";AACA;;;GAGG"}

package/dist/postinstall.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env bun
+/**
+ * Post-install script
+ * Automatically creates Claude Code skill link after npm install
+ */
+import { existsSync, mkdirSync } from 'fs';
+import { symlinkSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+// Colors for terminal output
+const GREEN = '\x1b[0;32m';
+const BLUE = '\x1b[0;34m';
+const YELLOW = '\x1b[1;33m';
+const NC = '\x1b[0m';
+function log(msg, color = GREEN) {
+    console.log(`${color}${msg}${NC}`);
+}
+async function main() {
+    // Only run for global installation
+    const isGlobal = process.env.npm_config_global === 'true';
+    if (!isGlobal) {
+        return;
+    }
+    // Get the package directory (dist folder)
+    // We're in dist/postinstall.js, so go up one level
+    const packageDir = dirname(__dirname);
+    // Claude Code skills directory
+    const skillsDir = join(process.env.HOME || '', '.claude', 'skills');
+    const linkPath = join(skillsDir, 'vault');
+    try {
+        // Create skills directory if it doesn't exist
+        if (!existsSync(skillsDir)) {
+            mkdirSync(skillsDir, { recursive: true });
+        }
+        // Check if link already exists
+        if (existsSync(linkPath)) {
+            // Remove old link
+            const { rmSync } = await import('fs');
+            try {
+                rmSync(linkPath, { recursive: true, force: true });
+            }
+            catch {
+                // Ignore error
+            }
+        }
+        // Create symbolic link
+        symlinkSync(packageDir, linkPath);
+        log('');
+        log('🔐 Vault - AI Secret Management', BLUE);
+        log('━'.repeat(40));
+        log('');
+        log('✓ Claude Code 技能已安装', GREEN);
+        log('');
+        log('下一步：');
+        log('  1. 初始化: ' + YELLOW + 'vault init' + NC);
+        log('  2. 然后在 Claude Code 中说：');
+        log('     「记住我的密钥是 xxx」');
+        log('');
+    }
+    catch (error) {
+        // Silently fail - don't break installation
+        // User can manually create link if needed
+    }
+}
+main().catch(() => { });
+//# sourceMappingURL=postinstall.js.map

package/dist/postinstall.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postinstall.js","sourceRoot":"","sources":["../src/postinstall.ts"],"names":[],"mappings":";AACA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,IAAI,CAAA;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAA;AAChC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAA;AAEnC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACjD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;AAErC,6BAA6B;AAC7B,MAAM,KAAK,GAAG,YAAY,CAAA;AAC1B,MAAM,IAAI,GAAG,YAAY,CAAA;AACzB,MAAM,MAAM,GAAG,YAAY,CAAA;AAC3B,MAAM,EAAE,GAAG,SAAS,CAAA;AAEpB,SAAS,GAAG,CAAC,GAAW,EAAE,KAAK,GAAG,KAAK;IACrC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,GAAG,GAAG,EAAE,EAAE,CAAC,CAAA;AACpC,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,mCAAmC;IACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,KAAK,MAAM,CAAA;IACzD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAM;IACR,CAAC;IAED,0CAA0C;IAC1C,mDAAmD;IACnD,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;IAErC,+BAA+B;IAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAA;IACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IAEzC,IAAI,CAAC;QACH,8CAA8C;QAC9C,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3B,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAC3C,CAAC;QAED,+BAA+B;QAC/B,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,kBAAkB;YAClB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,CAAA;YACrC,IAAI,CAAC;gBACH,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;YACpD,CAAC;YAAC,MAAM,CAAC;gBACP,eAAe;YACjB,CAAC;QACH,CAAC;QAED,uBAAuB;QACvB,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QAEjC,GAAG,CAAC,EAAE,CAAC,CAAA;QACP,GAAG,CAAC,iCAAiC,EAAE,IAAI,CAAC,CAAA;QAC5C,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;QACnB,GAAG,CAAC,EAAE,CAAC,CAAA;QACP,GAAG,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAA;QACjC,GAAG,CAAC,EAAE,CAAC,CAAA;QACP,GAAG,CAAC,MAAM,CAAC,CAAA;QACX,GAAG,CAAC,YAAY,GAAG,MAAM,GAAG,YAAY,GAAG,EAAE,CAAC,CAAA;QAC9C,GAAG,CAAC,0BAA0B,CAAC,CAAA;QAC/B,GAAG,CAAC,oBAAoB,CAAC,CAAA;QACzB,GAAG,CAAC,EAAE,CAAC,CAAA;IAET,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,2CAA2C;QAC3C,0CAA0C;IAC5C,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@principle2026/vault",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Vault - AI-powered secret management for Claude Code",
   "type": "module",
   "main": "dist/index.js",