english-optimizer-cli 1.1.0 → 1.3.0

package/API_SETUP.md

@@ -0,0 +1,186 @@
+# 使用云端API配置指南
+
+## 方法1: 使用配置文件
+
+在用户目录创建或编辑配置文件：
+
+```bash
+# 创建配置目录
+mkdir -p ~/.english-optimizer
+
+# 创建或编辑配置文件
+code ~/.english-optimizer/config.yaml
+# 或者使用其他编辑器
+```
+
+### OpenAI 配置
+
+```yaml
+ai:
+  provider: 'api'
+  api:
+    provider: 'openai'
+    apiKey: 'sk-your-openai-api-key-here'
+    baseUrl: 'https://api.openai.com/v1'
+    model: 'gpt-3.5-turbo'
+    # 或者使用更新的模型
+    model: 'gpt-4o'
+    model: 'gpt-4o-mini'
+```
+
+### GLM (智谱AI) 配置
+
+```yaml
+ai:
+  provider: 'api'
+  api:
+    provider: 'glm'
+    apiKey: 'your-glm-api-key-here'
+    baseUrl: 'https://open.bigmodel.cn/api/paas/v4'
+    model: 'glm-4'
+    # 或者使用更便宜的模型
+    model: 'glm-4-flash'
+```
+
+### DeepSeek 配置
+
+```yaml
+ai:
+  provider: 'api'
+  api:
+    provider: 'custom'
+    apiKey: 'your-deepseek-api-key-here'
+    baseUrl: 'https://api.deepseek.com/v1'
+    model: 'deepseek-chat'
+```
+
+### Claude (Anthropic) 配置
+
+注意：Claude 使用不同的API格式，可能需要调整代码
+
+```yaml
+ai:
+  provider: 'api'
+  api:
+    provider: 'custom'
+    apiKey: 'your-anthropic-api-key-here'
+    baseUrl: 'https://api.anthropic.com/v1'
+    model: 'claude-3-5-sonnet-20241022'
+```
+
+### 其他兼容OpenAI格式的API
+
+如果服务使用OpenAI兼容格式：
+
+```yaml
+ai:
+  provider: 'api'
+  api:
+    provider: 'custom'
+    apiKey: 'your-api-key-here'
+    baseUrl: 'https://your-api-endpoint.com/v1'
+    model: 'your-model-name'
+```
+
+## 方法2: 使用环境变量
+
+在项目目录创建 `.env` 文件：
+
+```bash
+cp .env.example .env
+code .env
+```
+
+### OpenAI 环境变量
+
+```env
+AI_PROVIDER=api
+API_PROVIDER=openai
+API_KEY=sk-your-openai-api-key-here
+API_BASE_URL=https://api.openai.com/v1
+API_MODEL=gpt-4o
+```
+
+### GLM 环境变量
+
+```env
+AI_PROVIDER=api
+API_PROVIDER=glm
+API_KEY=your-glm-api-key-here
+API_BASE_URL=https://open.bigmodel.cn/api/paas/v4
+API_MODEL=glm-4
+```
+
+### DeepSeek 环境变量
+
+```env
+AI_PROVIDER=api
+API_PROVIDER=custom
+API_KEY=your-deepseek-api-key-here
+API_BASE_URL=https://api.deepseek.com/v1
+API_MODEL=deepseek-chat
+```
+
+## 常用大模型API配置
+
+### OpenAI (GPT系列)
+
+- API Key: https://platform.openai.com/api-keys
+- Base URL: `https://api.openai.com/v1`
+- Models: `gpt-4o`, `gpt-4o-mini`, `gpt-3.5-turbo`
+
+### GLM-4 (智谱AI)
+
+- API Key: https://open.bigmodel.cn/usercenter/apikeys
+- Base URL: `https://open.bigmodel.cn/api/paas/v4`
+- Models: `glm-4`, `glm-4-flash`, `glm-3-turbo`
+
+### DeepSeek
+
+- API Key: https://platform.deepseek.com/
+- Base URL: `https://api.deepseek.com/v1`
+- Models: `deepseek-chat`, `deepseek-coder`
+
+### 阿里通义千问
+
+- API Key: https://dashscope.console.aliyun.com/
+- Base URL: `https://dashscope.aliyuncs.com/compatible-mode/v1`
+- Models: `qwen-turbo`, `qwen-plus`, `qwen-max`
+
+### 月之暗面 (Moonshot/Kimi)
+
+- API Key: https://platform.moonshot.cn/
+- Base URL: `https://api.moonshot.cn/v1`
+- Models: `moonshot-v1-8k`, `moonshot-v1-32k`, `moonshot-v1-128k`
+
+## 验证配置
+
+配置完成后，测试是否工作：
+
+```bash
+# 检查配置
+fuck-abc config
+
+# 启动CLI测试
+fuck-abc
+```
+
+## 切换回本地LLM
+
+如果想切回本地Ollama：
+
+```yaml
+ai:
+  provider: 'ollama'
+  ollama:
+    baseUrl: 'http://localhost:11434'
+    model: 'llama3.2:3b'
+```
+
+或者使用环境变量：
+
+```env
+AI_PROVIDER=ollama
+OLLAMA_BASE_URL=http://localhost:11434
+OLLAMA_MODEL=llama3.2:3b
+```

package/README.md

@@ -215,9 +215,21 @@ fuck-abc prompts
 ### Check Configuration
 
 ```bash
+# Show current configuration
 fuck-abc config
+
+# Run interactive setup wizard
+fuck-abc config --setup
 ```
 
+The setup wizard will guide you through:
+
+- Choosing AI provider (local Ollama or cloud API)
+- Configuring API settings
+- Setting up preferences
+
+### Using Cloud APIs (OpenAI, GLM, DeepSeek, etc.)
+
 ## YAML Prompt Configuration
 
 The CLI supports YAML-based prompt configuration for more advanced customization.
@@ -290,6 +302,32 @@ The CLI can be configured via:
 1. **Environment Variables** (`.env` file)
 2. **Config File** (`~/.english-optimizer/config.yaml` or `~/.english-optimizer/config.json`)
 
+### Using Cloud APIs (OpenAI, GLM, DeepSeek, etc.)
+
+By default, the CLI uses local Ollama. To use cloud APIs, you need to configure them.
+
+**Quick Setup:**
+
+1. Copy the example environment file:
+
+```bash
+cp .env.example .env
+```
+
+2. Edit `.env` with your API configuration:
+
+```env
+AI_PROVIDER=api
+API_PROVIDER=openai  # or 'glm', 'custom'
+API_KEY=your_api_key_here
+API_BASE_URL=https://api.openai.com/v1
+API_MODEL=gpt-4o
+```
+
+For detailed API configuration instructions, see [API_SETUP.md](API_SETUP.md)
+
+### Config File
+
 ### Environment Variables
 
 Copy `.env.example` to `.env`:

package/config.yaml

@@ -13,11 +13,41 @@ ai:
 
   # API Configuration (when provider: 'api')
   api:
-    provider: 'openai' # Options: 'openai', 'glm', 'custom'
-    apiKey: '' # Your API key
+    # Provider type: 'openai', 'glm', or 'custom'
+    provider: 'openai'
+
+    # Your API key (get from your API provider's dashboard)
+    apiKey: ''
+
+    # API endpoint URL
     baseUrl: 'https://api.openai.com/v1'
+
+    # Model name to use
     model: 'gpt-3.5-turbo'
 
+    # OpenAI Examples:
+    # - apiKey: 'sk-xxx'
+    # - baseUrl: 'https://api.openai.com/v1'
+    # - model: 'gpt-4o' or 'gpt-4o-mini' or 'gpt-3.5-turbo'
+
+    # GLM (Zhipu AI) Examples:
+    # - provider: 'glm'
+    # - apiKey: 'your-glm-key'
+    # - baseUrl: 'https://open.bigmodel.cn/api/paas/v4'
+    # - model: 'glm-4' or 'glm-4-flash'
+
+    # DeepSeek Examples:
+    # - provider: 'custom'
+    # - apiKey: 'your-deepseek-key'
+    # - baseUrl: 'https://api.deepseek.com/v1'
+    # - model: 'deepseek-chat'
+
+    # Aliyun Qwen Examples:
+    # - provider: 'custom'
+    # - apiKey: 'your-qwen-key'
+    # - baseUrl: 'https://dashscope.aliyuncs.com/compatible-mode/v1'
+    # - model: 'qwen-turbo' or 'qwen-plus'
+
 # Hotkey mappings for interactive mode
 hotkeys:
   professional: 'p'
@@ -35,4 +65,3 @@ features:
   enableCustomPrompts: true
   customPromptsPath: ~/.english-optimizer/prompts.json
   useYAMLPrompt: true # Enable YAML prompt configuration from prompt.yaml
-

package/dist/config/wizard.js

@@ -0,0 +1,183 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runConfigWizard = runConfigWizard;
+const inquirer_1 = __importDefault(require("inquirer"));
+const chalk_1 = __importDefault(require("chalk"));
+const config_1 = require("./config");
+async function runConfigWizard() {
+    console.log(chalk_1.default.cyan.bold('\n🚀 English Optimizer CLI - Configuration Wizard\n'));
+    const configManager = new config_1.ConfigManager();
+    const currentConfig = configManager.getConfig();
+    const answers = await inquirer_1.default.prompt([
+        {
+            type: 'list',
+            name: 'provider',
+            message: 'Select AI provider:',
+            choices: [
+                { name: '🤖 Ollama (Local)', value: 'ollama' },
+                { name: '☁️  Cloud API (OpenAI, GLM, etc.)', value: 'api' },
+            ],
+            default: currentConfig.ai.provider,
+        },
+        {
+            type: 'input',
+            name: 'ollamaBaseUrl',
+            message: 'Ollama base URL:',
+            default: currentConfig.ai.ollama?.baseUrl || 'http://localhost:11434',
+            when: (answers) => answers.provider === 'ollama',
+            validate: (input) => {
+                try {
+                    new URL(input);
+                    return true;
+                }
+                catch {
+                    return 'Please enter a valid URL';
+                }
+            },
+        },
+        {
+            type: 'input',
+            name: 'ollamaModel',
+            message: 'Ollama model name:',
+            default: currentConfig.ai.ollama?.model || 'llama3.2:3b',
+            when: (answers) => answers.provider === 'ollama',
+        },
+        {
+            type: 'list',
+            name: 'apiProvider',
+            message: 'Select API provider:',
+            choices: [
+                { name: '🔵 OpenAI (GPT-4, GPT-3.5)', value: 'openai' },
+                { name: '🟢 GLM (Zhipu AI)', value: 'glm' },
+                { name: '🔷 DeepSeek', value: 'deepseek' },
+                { name: '🟣 Aliyun Qwen', value: 'qwen' },
+                { name: '🌙 Moonshot (Kimi)', value: 'moonshot' },
+                { name: '🔧 Custom API', value: 'custom' },
+            ],
+            default: currentConfig.ai.api?.provider || 'openai',
+            when: (answers) => answers.provider === 'api',
+        },
+        {
+            type: 'input',
+            name: 'apiKey',
+            message: 'Enter your API key:',
+            default: currentConfig.ai.api?.apiKey || '',
+            when: (answers) => answers.provider === 'api',
+            validate: (input) => {
+                if (!input || input.trim() === '') {
+                    return 'API key cannot be empty';
+                }
+                return true;
+            },
+        },
+        {
+            type: 'input',
+            name: 'apiBaseUrl',
+            message: 'API base URL:',
+            default: (answers) => {
+                const currentUrl = currentConfig.ai.api?.baseUrl || '';
+                const providerDefaults = {
+                    openai: 'https://api.openai.com/v1',
+                    glm: 'https://open.bigmodel.cn/api/paas/v4',
+                    deepseek: 'https://api.deepseek.com/v1',
+                    qwen: 'https://dashscope.aliyuncs.com/compatible-mode/v1',
+                    moonshot: 'https://api.moonshot.cn/v1',
+                    custom: currentUrl,
+                };
+                return providerDefaults[answers.apiProvider] || currentUrl;
+            },
+            when: (answers) => answers.provider === 'api',
+            validate: (input) => {
+                try {
+                    new URL(input);
+                    return true;
+                }
+                catch {
+                    return 'Please enter a valid URL';
+                }
+            },
+        },
+        {
+            type: 'input',
+            name: 'apiModel',
+            message: 'Model name:',
+            default: (answers) => {
+                const currentModel = currentConfig.ai.api?.model || '';
+                const modelDefaults = {
+                    openai: 'gpt-4o',
+                    glm: 'glm-4',
+                    deepseek: 'deepseek-chat',
+                    qwen: 'qwen-turbo',
+                    moonshot: 'moonshot-v1-8k',
+                    custom: currentModel,
+                };
+                return modelDefaults[answers.apiProvider] || currentModel;
+            },
+            when: (answers) => answers.provider === 'api',
+        },
+        {
+            type: 'confirm',
+            name: 'enableHistory',
+            message: 'Enable optimization history?',
+            default: currentConfig.features.enableHistory ?? true,
+        },
+        {
+            type: 'confirm',
+            name: 'enableYAMLPrompt',
+            message: 'Use YAML prompt configuration (conversational mode)?',
+            default: true,
+        },
+    ]);
+    // Build new config
+    const newConfig = {
+        ...currentConfig,
+        ai: {
+            provider: answers.provider,
+            ollama: answers.provider === 'ollama'
+                ? {
+                    baseUrl: answers.ollamaBaseUrl,
+                    model: answers.ollamaModel,
+                }
+                : undefined,
+            api: answers.provider === 'api'
+                ? {
+                    provider: answers.apiProvider,
+                    apiKey: answers.apiKey,
+                    baseUrl: answers.apiBaseUrl,
+                    model: answers.apiModel,
+                }
+                : undefined,
+        },
+        features: {
+            ...currentConfig.features,
+            enableHistory: answers.enableHistory,
+            useYAMLPrompt: answers.enableYAMLPrompt,
+        },
+    };
+    // Save config
+    console.log(chalk_1.default.cyan('\n💾 Saving configuration...\n'));
+    configManager.saveConfig(newConfig);
+    console.log(chalk_1.default.green.bold('✅ Configuration saved successfully!\n'));
+    // Show summary
+    console.log(chalk_1.default.white.bold('Current Configuration:\n'));
+    console.log(chalk_1.default.gray('─'.repeat(50)));
+    if (answers.provider === 'ollama') {
+        console.log(chalk_1.default.cyan(`Provider: ${chalk_1.default.bold('Ollama (Local)')}`));
+        console.log(chalk_1.default.cyan(`  URL: ${newConfig.ai.ollama.baseUrl}`));
+        console.log(chalk_1.default.cyan(`  Model: ${newConfig.ai.ollama.model}`));
+    }
+    else {
+        console.log(chalk_1.default.cyan(`Provider: ${chalk_1.default.bold(answers.apiProvider)}`));
+        console.log(chalk_1.default.cyan(`  URL: ${newConfig.ai.api.baseUrl}`));
+        console.log(chalk_1.default.cyan(`  Model: ${newConfig.ai.api.model}`));
+    }
+    console.log(chalk_1.default.cyan(`History: ${answers.enableHistory ? 'Enabled' : 'Disabled'}`));
+    console.log(chalk_1.default.cyan(`YAML Prompt: ${answers.enableYAMLPrompt ? 'Enabled' : 'Disabled'}`));
+    console.log(chalk_1.default.gray('─'.repeat(50)));
+    console.log(chalk_1.default.green('\n🎉 Ready to use! Run:'));
+    console.log(chalk_1.default.white.bold('  fuck-abc\n'));
+}
+//# sourceMappingURL=wizard.js.map

package/dist/index.js

@@ -136,11 +136,18 @@ program
 });
 program
     .command('config')
-    .description('Show current configuration')
-    .action(() => {
+    .description('Show current configuration or run setup wizard')
+    .option('-s, --setup', 'Run interactive setup wizard', false)
+    .action(async (options) => {
     try {
-        const config = config_1.configManager.getConfig();
-        console.log(JSON.stringify(config, null, 2));
+        if (options.setup) {
+            const { runConfigWizard } = await Promise.resolve().then(() => __importStar(require('./config/wizard')));
+            await runConfigWizard();
+        }
+        else {
+            const config = config_1.configManager.getConfig();
+            console.log(JSON.stringify(config, null, 2));
+        }
     }
     catch (error) {
         (0, display_1.displayError)(error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "english-optimizer-cli",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "CLI tool to help non-native English speakers improve their writing using AI",
   "main": "dist/index.js",
   "bin": {

package/prompt.yaml

@@ -6,9 +6,9 @@ role:
     casual, direct, and natural. No formal or academic language.
 
 goals:
-  - Help the user speak like a native engineer in daily team communication
+  - Help user speak like a native engineer in daily team communication
   - Translate or rewrite to sound like real workplace chat messages
-  - Make it sound like something you would say in Slack/Teams, not a formal email
+  - Make it sound like something you would say in Slack or Teams, not a formal email
   - Avoid official or textbook-style translations completely
 
 user_profile:
@@ -20,13 +20,15 @@ instructions:
   - Think how a native engineer would say this in Slack or Teams
   - Use casual conversational language, think team chat not formal report
   - Keep it short and simple like real chat messages
-  - Use contractions always such as it is becomes it is
-  - For it is works output just It works, never functions as intended
+  - Use contractions always such as it is becomes it is not it is becomes it is
+  - For it is works output just It works or It works, never anything formal
+  - For it is work output something like Working on it or It is working
   - For check this use Can you check this or Take a look
   - For it is good use It looks good or Looks great
-  - Avoid formal words such as functions, intended, comprises, utilize, regarding
+  - Avoid formal words such as functions, intended, comprises, utilize, regarding, task at hand
   - Use simple everyday words engineers actually use
   - Match energy of real team communication, slightly informal is good
+  - Be very direct and simple
 
 output_format:
   style: >
@@ -39,38 +41,54 @@ examples:
   - input: "it's works"
     output: 'It works!'
 
+  - input: "it's work"
+    output: 'It is working'
+
   - input: 'The code is done'
-    output: 'Code is done.'
+    output: 'Code is done'
 
   - input: 'Please check this'
     output: 'Can you check this?'
 
   - input: 'I think there is a bug'
-    output: 'I think there is a bug.'
+    output: 'I think there is a bug'
 
   - input: 'This is very good'
     output: 'This looks great!'
 
   - input: 'The problem will be solved'
-    output: 'I will fix this.'
+    output: 'I will fix this'
 
   - input: 'Let us discuss tomorrow'
-    output: 'Let us talk tomorrow.'
+    output: 'Let us talk tomorrow'
 
   - input: 'Thank you very much'
-    output: 'Thanks!'
+    output: 'Thanks'
 
   - input: 'I will send you the information'
-    output: 'I will send you the info.'
+    output: 'I will send you the info'
 
   - input: 'It is not correct'
-    output: 'That is not right.'
+    output: 'That is not right'
 
   - input: 'Please wait a moment'
     output: 'Hang on a sec'
 
+  - input: 'This is working'
+    output: 'It works'
+
+  - input: 'Good job'
+    output: 'Nice work'
+
+  - input: 'I am going to do it'
+    output: 'I will do it'
+
+  - input: 'Can you help me?'
+    output: 'Can you help?'
+
 constraints:
   - Do not over-explain
   - Keep it as short as a real chat message would be
   - No formal business language at all
   - Sound like you are typing in Slack to a teammate
+  - Never use phrases like task at hand or functions as intended