viho 0.0.3 → 0.0.5

package/README.md

@@ -1 +1,235 @@
-## viho
+<p align="center">
+  <img src="./logo.png" alt="viho logo" width="200"/>
+</p>
+
+<h1 align="center">viho</h1>
+
+<p align="center">A lightweight CLI tool for managing and interacting with AI models.</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/viho"><img src="https://img.shields.io/npm/v/viho.svg" alt="npm version"></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
+</p>
+
+## Features
+
+- Multiple AI model management
+- Interactive Q&A with streaming responses
+- Continuous chat sessions for multi-turn conversations
+- Support for thinking mode (enabled/disabled/auto)
+- Configurable API endpoints (OpenAI, Anthropic, custom providers)
+- Default model configuration
+- Simple and intuitive CLI interface
+- Persistent configuration storage
+
+## Installation
+
+Install globally via npm:
+
+```bash
+npm install -g viho
+```
+
+## Requirements
+
+- Node.js >= 18.0.0
+
+## Quick Start
+
+1. Add your first AI model:
+
+```bash
+viho model add
+```
+
+2. Set it as default:
+
+```bash
+viho model default
+```
+
+3. Start asking questions:
+
+```bash
+viho ask
+```
+
+## Commands
+
+### Model Management
+
+#### `viho model add`
+
+Add a new AI model configuration interactively.
+
+You'll be prompted to enter:
+
+- Model name (a custom identifier)
+- API key
+- Base URL (e.g., https://api.openai.com/v1)
+- Model ID (e.g., gpt-4, claude-3-5-sonnet-20241022)
+- Thinking mode (enabled/disabled/auto)
+
+```bash
+viho model add
+```
+
+#### `viho model list`
+
+List all configured models:
+
+```bash
+viho model list
+```
+
+#### `viho model remove`
+
+Remove a model configuration:
+
+```bash
+viho model remove
+```
+
+#### `viho model default`
+
+Set a default model for chat sessions:
+
+```bash
+viho model default
+```
+
+### Ask
+
+#### `viho ask [modelName]`
+
+Ask a question to an AI model.
+
+If no model name is provided, uses the default model:
+
+```bash
+viho ask
+```
+
+Or specify a model explicitly:
+
+```bash
+viho ask mymodel
+```
+
+The interface includes:
+
+- Editor-based question input
+- Streaming responses
+- Visual thinking process (when enabled)
+- Colored output for better readability
+
+### Chat
+
+#### `viho chat [modelName]`
+
+Start a continuous chat session with an AI model for multi-turn conversations.
+
+If no model name is provided, uses the default model:
+
+```bash
+viho chat
+```
+
+Or specify a model explicitly:
+
+```bash
+viho chat mymodel
+```
+
+The chat session runs in a loop, allowing you to ask multiple questions continuously without restarting the command. Each question uses the same model configuration but starts a fresh conversation context.
+
+**Note:** The main difference between `viho ask` and `viho chat`:
+
+- `viho ask` - Single question, exits after receiving the answer
+- `viho chat` - Continuous loop, keeps asking for new questions until manually stopped (Ctrl+C)
+
+## Configuration
+
+Configuration is stored in `~/viho.json`. You can manage all settings through the CLI commands.
+
+### Example Configuration Structure
+
+```json
+{
+  "mymodel": {
+    "modelName": "mymodel",
+    "apiKey": "your-api-key",
+    "baseURL": "https://api.openai.com/v1",
+    "modelID": "gpt-4",
+    "modelThinking": "auto"
+  },
+  "default": "mymodel"
+}
+```
+
+## Supported Providers
+
+viho works with any OpenAI-compatible API, including:
+
+- OpenAI (GPT-4, GPT-3.5, etc.)
+- Anthropic Claude (via compatible endpoints)
+- Custom LLM providers with OpenAI-compatible APIs
+
+## Examples
+
+### Adding an OpenAI Model
+
+```bash
+viho model add
+# Enter model name: gpt4
+# Enter API key: sk-...
+# Enter base URL: https://api.openai.com/v1
+# Enter model ID: gpt-4
+# Thinking mode: disabled
+```
+
+### Adding a Claude Model
+
+```bash
+viho model add
+# Enter model name: claude
+# Enter API key: your-anthropic-key
+# Enter base URL: https://api.anthropic.com
+# Enter model ID: claude-3-5-sonnet-20241022
+# Thinking mode: auto
+```
+
+### Setting Up for First Use
+
+```bash
+# Add a model
+viho model add
+
+# Set it as default
+viho model default
+
+# Start asking questions
+viho ask
+```
+
+## Dependencies
+
+- [qiao-cli](https://www.npmjs.com/package/qiao-cli) - CLI utilities
+- [qiao-config](https://www.npmjs.com/package/qiao-config) - Configuration management
+- [qiao-llm](https://www.npmjs.com/package/qiao-llm) - LLM integration
+
+## License
+
+MIT
+
+## Author
+
+uikoo9 <uikoo9@qq.com>
+
+## Issues
+
+Report issues at: https://github.com/uikoo9/viho/issues
+
+## Homepage
+
+https://github.com/uikoo9/viho

package/bin/util.js

@@ -0,0 +1,103 @@
+// os
+const os = require('os');
+
+// path
+const path = require('path');
+
+// qiao
+const cli = require('qiao-cli');
+
+// db
+const DB = require('qiao-config');
+
+/**
+ * getDB
+ * @returns
+ */
+exports.getDB = () => {
+  const dbPath = path.resolve(os.homedir(), './viho.json');
+  return DB(dbPath);
+};
+
+/**
+ * printLogo
+ */
+exports.printLogo = () => {
+  console.log(
+    cli.colors.green(`
+██╗   ██╗██╗██╗  ██╗ ██████╗
+██║   ██║██║██║  ██║██╔═══██╗
+██║   ██║██║███████║██║   ██║
+╚██╗ ██╔╝██║██╔══██║██║   ██║
+ ╚████╔╝ ██║██║  ██║╚██████╔╝
+  ╚═══╝  ╚═╝╚═╝  ╚═╝ ╚═════╝
+    `),
+  );
+};
+
+/**
+ * ask
+ * @param {*} llm
+ * @param {*} model
+ */
+exports.ask = async (llm, model) => {
+  // ask
+  const questions = [
+    {
+      type: 'editor',
+      name: 'content',
+      message: 'Your question:',
+    },
+  ];
+  const answers = await cli.ask(questions);
+
+  // answers
+  console.log();
+  console.log(cli.colors.gray('Question:'));
+  console.log(cli.colors.gray(answers.content));
+  console.log();
+
+  // chat
+  const chatOptions = {
+    model: model.modelID,
+    messages: [
+      { role: 'system', content: 'You are a helpful AI assistant' },
+      { role: 'user', content: answers.content },
+    ],
+    thinking: {
+      type: model.modelThinking,
+    },
+  };
+
+  // callback options
+  const callbackOptions = {
+    firstThinkingCallback: () => {
+      console.log();
+      console.log(cli.colors.gray('[Thinking...]'));
+      console.log();
+    },
+    thinkingCallback: (msg) => {
+      process.stdout.write(cli.colors.gray(msg));
+    },
+    firstContentCallback: () => {
+      console.log();
+      console.log(cli.colors.cyan('[Response]'));
+      console.log();
+    },
+    contentCallback: (msg) => {
+      process.stdout.write(msg);
+    },
+    endCallback: () => {
+      console.log();
+      console.log();
+    },
+    errorCallback: (error) => {
+      console.log();
+      console.log(cli.colors.red('Error:'));
+      console.log(error);
+    },
+  };
+
+  // go
+  await llm.chatWithStreaming(chatOptions, callbackOptions);
+};

package/bin/viho-ask.js

@@ -0,0 +1,43 @@
+// qiao
+const cli = require('qiao-cli');
+
+// llm
+const LLM = require('qiao-llm');
+
+// util
+const { getDB, ask, printLogo } = require('./util.js');
+const db = getDB();
+
+// cmd
+cli.cmd
+  .command('ask [modelName]')
+  .description('Ask a question to an AI model')
+  .action(async (modelName) => {
+    if (!modelName) {
+      const defaultModel = await db.config('default');
+      if (!defaultModel) {
+        console.log(cli.colors.red('No default model set. Use: viho model default'));
+        return;
+      }
+
+      modelName = defaultModel;
+    }
+
+    // check
+    const model = await db.config(modelName);
+    if (!model) {
+      console.log(cli.colors.red(`Model not found: ${modelName}`));
+      return;
+    }
+
+    // init
+    const llm = LLM({
+      apiKey: model.apiKey,
+      baseURL: model.baseURL,
+    });
+
+    // logo
+    printLogo();
+
+    await ask(llm, model);
+  });

package/bin/viho-chat.js

@@ -0,0 +1,49 @@
+// qiao
+const cli = require('qiao-cli');
+
+// llm
+const LLM = require('qiao-llm');
+
+// util
+const { getDB, ask, printLogo } = require('./util.js');
+const db = getDB();
+
+// cmd
+cli.cmd
+  .command('chat [modelName]')
+  .description('Start a continuous chat session with an AI model')
+  .action(async (modelName) => {
+    if (!modelName) {
+      const defaultModel = await db.config('default');
+      if (!defaultModel) {
+        console.log(cli.colors.red('No default model set. Use: viho model default'));
+        return;
+      }
+
+      modelName = defaultModel;
+    }
+
+    // check
+    const model = await db.config(modelName);
+    if (!model) {
+      console.log(cli.colors.red(`Model not found: ${modelName}`));
+      return;
+    }
+
+    // init
+    const llm = LLM({
+      apiKey: model.apiKey,
+      baseURL: model.baseURL,
+    });
+
+    // logo
+    printLogo();
+    console.log(cli.colors.cyan(`Welcome to viho chat! Using model: ${modelName}`));
+    console.log(cli.colors.gray('Press Ctrl+C to exit\n'));
+
+    // chat
+    let keepChatting = true;
+    while (keepChatting) {
+      await ask(llm, model);
+    }
+  });

package/bin/viho-model.js

@@ -0,0 +1,188 @@
+// qiao
+const cli = require('qiao-cli');
+
+// util
+const { getDB, printLogo } = require('./util.js');
+const db = getDB();
+
+// actions
+const actions = ['add', 'list', 'remove', 'default'];
+
+// model
+cli.cmd
+  .command('model <action>')
+  .description('Manage AI models')
+  .action((action) => {
+    if (!actions.includes(action)) {
+      console.log(cli.colors.red('Invalid action. Use: add, list, remove, default'));
+      return;
+    }
+
+    // actions
+    if (action === 'add') modelAdd();
+    if (action === 'list') modelList();
+    if (action === 'remove') modelRemove();
+    if (action === 'default') modelDefault();
+  });
+
+/**
+ * modelAdd
+ * @returns
+ */
+async function modelAdd() {
+  try {
+    // q a
+    const questions = [
+      {
+        type: 'input',
+        name: 'modelName',
+        message: 'Enter model name:',
+      },
+      {
+        type: 'input',
+        name: 'apiKey',
+        message: 'Enter API key:',
+      },
+      {
+        type: 'input',
+        name: 'baseURL',
+        message: 'Enter base URL:',
+      },
+      {
+        type: 'input',
+        name: 'modelID',
+        message: 'Enter model ID:',
+      },
+      {
+        type: 'list',
+        name: 'modelThinking',
+        message: 'Thinking mode:',
+        choices: ['enabled', 'disabled', 'auto'],
+      },
+    ];
+    const answers = await cli.ask(questions);
+    console.log();
+
+    // check
+    const dbKey = answers.modelName;
+    const dbValue = await db.config(dbKey);
+    if (dbValue) {
+      console.log(cli.colors.red('Model name already exists'));
+      return;
+    }
+
+    // set
+    await db.config(dbKey, answers);
+    console.log(cli.colors.green('Model added'));
+    console.log();
+
+    // list
+    const all = await db.all();
+    console.log(all);
+  } catch (e) {
+    console.log(cli.colors.red('Error: Failed to add model'));
+    console.log();
+    console.log(e);
+  }
+}
+
+/**
+ * modelList
+ */
+async function modelList() {
+  try {
+    // logo
+    printLogo();
+
+    // list
+    const all = await db.all();
+    console.log(cli.colors.cyan('Configured models:'));
+    console.log();
+    console.log(all);
+  } catch (e) {
+    console.log(cli.colors.red('Error: Failed to list models'));
+    console.log();
+
+    console.log(e);
+  }
+}
+
+/**
+ * modelRemove
+ */
+async function modelRemove() {
+  try {
+    // q a
+    const questions = [
+      {
+        type: 'input',
+        name: 'modelName',
+        message: 'Enter model name to remove:',
+      },
+    ];
+    const answers = await cli.ask(questions);
+    console.log();
+
+    // del
+    const dbKey = answers.modelName;
+    await db.config(dbKey, null);
+    console.log(cli.colors.green('Model removed'));
+    console.log();
+
+    // list
+    const all = await db.all();
+    console.log(all);
+  } catch (e) {
+    console.log(cli.colors.red('Error: Failed to remove model'));
+    console.log();
+
+    console.log(e);
+  }
+}
+
+/**
+ * modelDefault
+ * @returns
+ */
+async function modelDefault() {
+  try {
+    // q a
+    const questions = [
+      {
+        type: 'input',
+        name: 'modelName',
+        message: 'Enter default model name:',
+      },
+    ];
+    const answers = await cli.ask(questions);
+    console.log();
+
+    // get keys
+    const all = await db.all();
+    const keys = Object.keys(all);
+
+    // check keys
+    if (!keys || !keys.length) {
+      console.log(cli.colors.red('No models found. Add one first: viho model add'));
+      console.log();
+      return;
+    }
+
+    // check model
+    if (!keys.includes(answers.modelName)) {
+      console.log(cli.colors.red('Model not found. Available models:'));
+      console.log();
+      console.log(all);
+      return;
+    }
+
+    // set
+    await db.config('default', answers.modelName);
+    console.log(cli.colors.green(`Default model: ${answers.modelName}`));
+    console.log();
+  } catch (e) {
+    console.log(cli.colors.red('Error: Failed to set default model'));
+    console.log();
+    console.log(e);
+  }
+}

package/bin/viho.js

@@ -4,6 +4,9 @@
 const cli = require('qiao-cli');
 
 // cmds
+require('./viho-model.js');
+require('./viho-ask.js');
+require('./viho-chat.js');
 require('./viho-version.js');
 
 // parse

package/package.json

@@ -1,8 +1,21 @@
 {
   "name": "viho",
-  "version": "0.0.3",
-  "description": "",
-  "keywords": [],
+  "version": "0.0.5",
+  "description": "A lightweight CLI tool for managing and interacting with AI models",
+  "keywords": [
+    "ai",
+    "llm",
+    "qa",
+    "ask",
+    "chat",
+    "cli",
+    "chatgpt",
+    "anthropic",
+    "openai",
+    "ai-assistant",
+    "command-line",
+    "terminal"
+  ],
   "author": "uikoo9 <uikoo9@qq.com>",
   "license": "MIT",
   "homepage": "https://github.com/uikoo9/viho#readme",
@@ -19,13 +32,16 @@
   "files": [
     "bin",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "logo.png"
   ],
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "dependencies": {
-    "qiao-cli": "^5.0.0"
+    "qiao-cli": "^5.0.0",
+    "qiao-config": "^5.0.1",
+    "qiao-llm": "^0.2.5"
   },
-  "gitHead": "689ac084e471c52e399cc4dd83278cf51a380b15"
+  "gitHead": "4536783e6823add1a9556e0fb2f569e8d1f5bac0"
 }