@botskill/cli 1.0.3 → 1.0.5

package/src/lib/auth.js

@@ -1,95 +1,118 @@
-import path from 'path';
-import os from 'os';
-import Configstore from 'configstore';
-import axios from 'axios';
-import { getDefaultApiUrl } from './constants.js';
-
-const CONFIG_PATH = path.join(os.homedir(), '.skm', 'config.json');
-const defaultUrl = getDefaultApiUrl();
-
-const config = new Configstore('botskill-cli', { apiUrl: defaultUrl }, {
-  configPath: CONFIG_PATH,
-});
-
-export const getConfigPath = () => config.path;
-
-/** 优先级: 环境变量 BOTSKILL_API_URL > 配置文件 > 构建时默认值 */
-export const getApiUrl = () =>
-  process.env.BOTSKILL_API_URL || config.get('apiUrl') || getDefaultApiUrl();
-
-export const setApiUrl = (url) => config.set('apiUrl', url);
-
-export const getToken = () => config.get('token');
-
-export const getRefreshToken = () => config.get('refreshToken');
-
-export const getUser = () => config.get('user');
-
-export const setAuth = (data) => {
-  if (data.token || data.accessToken) {
-    config.set('token', data.token || data.accessToken);
-  }
-  if (data.refreshToken) {
-    config.set('refreshToken', data.refreshToken);
-  }
-  if (data.user) {
-    config.set('user', data.user);
-  }
-};
-
-export const clearAuth = () => {
-  config.delete('token');
-  config.delete('refreshToken');
-  config.delete('user');
-};
-
-export const isLoggedIn = () => !!config.get('token');
-
-export const createApiClient = () => {
-  const baseURL = getApiUrl();
-  const client = axios.create({
-    baseURL,
-    timeout: 15000,
-    headers: { 'Content-Type': 'application/json' },
-  });
-
-  client.interceptors.request.use((cfg) => {
-    const token = getToken();
-    if (token) {
-      cfg.headers.Authorization = `Bearer ${token}`;
-    }
-    return cfg;
-  });
-
-  client.interceptors.response.use(
-    (res) => res,
-    async (err) => {
-      if (err.response?.status !== 401) return Promise.reject(err);
-      const req = err.config;
-      if (req._retry) return Promise.reject(err);
-      if (req.url?.includes('/auth/login') || req.url?.includes('/auth/refresh')) {
-        return Promise.reject(err);
-      }
-
-      const refreshToken = getRefreshToken();
-      if (!refreshToken) return Promise.reject(err);
-
-      try {
-        const res = await axios.post(`${baseURL}/auth/refresh`, { refreshToken });
-        const data = res.data?.data || res.data;
-        const newToken = data.accessToken || data.token;
-        const newRefresh = data.refreshToken;
-        if (newToken) {
-          config.set('token', newToken);
-          if (newRefresh) config.set('refreshToken', newRefresh);
-          req._retry = true;
-          req.headers.Authorization = `Bearer ${newToken}`;
-          return client(req);
-        }
-      } catch (_) {}
-      return Promise.reject(err);
-    }
-  );
-
-  return client;
-};
+import path from 'path';
+import os from 'os';
+import Configstore from 'configstore';
+import axios from 'axios';
+import { getDefaultApiUrl } from './constants.js';
+
+const CONFIG_PATH = path.join(os.homedir(), '.skm', 'config.json');
+const defaultUrl = getDefaultApiUrl();
+
+const config = new Configstore('botskill-cli', { apiUrl: defaultUrl }, {
+  configPath: CONFIG_PATH,
+});
+
+export const getConfigPath = () => config.path;
+
+/** 规范化 API 地址：若未以 /api 结尾则自动追加，用户无需手动加 /api */
+export const normalizeApiUrl = (url) => {
+  if (!url || typeof url !== 'string') return url;
+  const u = url.replace(/\/+$/, '');
+  return u.endsWith('/api') ? u : `${u}/api`;
+};
+
+/** 优先级: 环境变量 BOTSKILL_API_URL > 配置文件 > 构建时默认值 */
+export const getApiUrl = () =>
+  normalizeApiUrl(process.env.BOTSKILL_API_URL || config.get('apiUrl') || getDefaultApiUrl());
+
+export const setApiUrl = (url) => config.set('apiUrl', url);
+
+export const getToken = () => config.get('token');
+
+export const getRefreshToken = () => config.get('refreshToken');
+
+export const getUser = () => config.get('user');
+
+export const setAuth = (data) => {
+  if (data.token || data.accessToken) {
+    config.set('token', data.token || data.accessToken);
+  }
+  if (data.refreshToken) {
+    config.set('refreshToken', data.refreshToken);
+  }
+  if (data.user) {
+    config.set('user', data.user);
+  }
+};
+
+export const clearAuth = () => {
+  config.delete('token');
+  config.delete('refreshToken');
+  config.delete('user');
+};
+
+export const isLoggedIn = () => !!config.get('token');
+
+/** 从 axios 错误中提取请求 URL，用于错误输出 */
+export const getErrorUrl = (err) => {
+  const cfg = err?.config;
+  if (!cfg) return getApiUrl();
+  if (cfg.url && (cfg.url.startsWith('http://') || cfg.url.startsWith('https://'))) return cfg.url;
+  if (cfg.baseURL) {
+    const p = cfg.url || '';
+    return cfg.baseURL.replace(/\/$/, '') + (p.startsWith('/') ? p : '/' + p);
+  }
+  return getApiUrl();
+};
+
+/**
+ * 创建 API 客户端
+ * @param {string} [overrideUrl] - 可选，覆盖本次请求的 API 地址（来自 --api-url）
+ */
+export const createApiClient = (overrideUrl) => {
+  const baseURL = normalizeApiUrl(overrideUrl || getApiUrl());
+  const client = axios.create({
+    baseURL,
+    timeout: 15000,
+    headers: { 'Content-Type': 'application/json' },
+  });
+
+  client.interceptors.request.use((cfg) => {
+    const token = getToken();
+    if (token) {
+      cfg.headers.Authorization = `Bearer ${token}`;
+    }
+    return cfg;
+  });
+
+  client.interceptors.response.use(
+    (res) => res,
+    async (err) => {
+      if (err.response?.status !== 401) return Promise.reject(err);
+      const req = err.config;
+      if (req._retry) return Promise.reject(err);
+      if (req.url?.includes('/auth/login') || req.url?.includes('/auth/refresh')) {
+        return Promise.reject(err);
+      }
+
+      const refreshToken = getRefreshToken();
+      if (!refreshToken) return Promise.reject(err);
+
+      try {
+        const res = await axios.post(`${baseURL}/auth/refresh`, { refreshToken });
+        const data = res.data?.data || res.data;
+        const newToken = data.accessToken || data.token;
+        const newRefresh = data.refreshToken;
+        if (newToken) {
+          config.set('token', newToken);
+          if (newRefresh) config.set('refreshToken', newRefresh);
+          req._retry = true;
+          req.headers.Authorization = `Bearer ${newToken}`;
+          return client(req);
+        }
+      } catch (_) {}
+      return Promise.reject(err);
+    }
+  );
+
+  return client;
+};

package/src/lib/constants.js

@@ -1,10 +1,10 @@
-/**
- * 默认 API 地址，可通过 build 时环境变量 BOTSKILL_API_URL 注入
- * 发布生产: BOTSKILL_API_URL=https://api.botskill.ai npm run build
- * 开发/本地: 保持 __DEFAULT_API_URL__ 时使用 localhost
- */
-export const DEFAULT_API_URL = "http://localhost:3001/api";
-export const FALLBACK_API_URL = 'http://localhost:3001/api';
-
-export const getDefaultApiUrl = () =>
-  DEFAULT_API_URL === '__DEFAULT_API_URL__' ? FALLBACK_API_URL : DEFAULT_API_URL;
+/**
+ * 默认 API 地址，可通过 build 时环境变量 BOTSKILL_API_URL 注入
+ * 发布生产: BOTSKILL_API_URL=https://api.botskill.ai npm run build
+ * 开发/本地: 保持 __DEFAULT_API_URL__ 时使用 localhost
+ */
+export const DEFAULT_API_URL = "http://localhost:3001/api";
+export const FALLBACK_API_URL = 'http://localhost:3000/api';
+
+export const getDefaultApiUrl = () =>
+  DEFAULT_API_URL === '__DEFAULT_API_URL__' ? FALLBACK_API_URL : DEFAULT_API_URL;

package/src/lib/formatError.js

@@ -0,0 +1,113 @@
+/**
+ * 统一格式化 API 错误输出，便于 CLI 排查问题
+ */
+import { getErrorUrl } from './auth.js';
+
+const dim = (s) => `\x1b[2m${s}\x1b[0m`;
+const red = (s) => `\x1b[31m${s}\x1b[0m`;
+const yellow = (s) => `\x1b[33m${s}\x1b[0m`;
+
+/**
+ * 从 axios 错误中提取用户可读的消息
+ */
+function extractMessage(err, fallback = 'Request failed') {
+  if (err._overrideMsg) return err._overrideMsg;
+  if (err.response?.data && !Buffer.isBuffer(err.response.data)) {
+    const d = err.response.data;
+    return d.error || d.message || (typeof d === 'string' ? d : fallback);
+  }
+  if (err.code === 'ECONNREFUSED') {
+    return 'Connection refused. Server may not be running.';
+  }
+  if (err.code === 'ENOTFOUND') {
+    return 'DNS lookup failed. Check API URL or network.';
+  }
+  if (err.code === 'ETIMEDOUT' || err.code === 'ECONNABORTED') {
+    return 'Request timed out.';
+  }
+  if (err.code === 'ERR_NETWORK') {
+    return 'Network error.';
+  }
+  return err.message || fallback;
+}
+
+/**
+ * 根据错误类型返回排查提示
+ */
+function getHints(err) {
+  const hints = [];
+  const status = err.response?.status;
+  const code = err.code;
+
+  if (code === 'ECONNREFUSED' || code === 'ENOTFOUND' || code === 'ETIMEDOUT' || code === 'ERR_NETWORK') {
+    hints.push('Run "skm config" to view or set API URL');
+    hints.push('Ensure the backend server is running');
+  }
+  if (status === 401) {
+    hints.push('Run "skm login" to authenticate');
+  }
+  if (status === 404) {
+    hints.push('Check if the resource exists');
+  }
+  if (status === 403) {
+    hints.push('Your account may not have permission');
+  }
+  if (status && status >= 500) {
+    hints.push('Server error. Try again later or contact support');
+  }
+
+  return hints;
+}
+
+/**
+ * 格式化并输出 API 错误信息（符合 CLI 风格，便于排查）
+ * @param {Error} err - axios 错误
+ * @param {Object} opts - 选项
+ * @param {string} opts.prefix - 错误前缀，如 "List failed"、"Download failed"
+ * @param {string} opts.fallback - 无消息时的默认文案
+ * @param {boolean} opts.skipUrl - 是否跳过 URL 输出（如登录失败时 URL 可能重复）
+ */
+export function formatApiError(err, opts = {}) {
+  const { prefix = 'Error', fallback = 'Request failed', skipUrl = false } = opts;
+  const msg = extractMessage(err, fallback);
+  const url = getErrorUrl(err);
+  const status = err.response?.status;
+  const hints = getHints(err);
+
+  const lines = [];
+
+  // 主错误信息
+  lines.push(red(`${prefix}: ${msg}`));
+
+  // 辅助信息：URL、状态码
+  const meta = [];
+  if (!skipUrl) meta.push(`URL: ${url}`);
+  if (status) meta.push(`HTTP ${status}`);
+  if (meta.length) lines.push(dim(meta.join('  |  ')));
+
+  // 排查提示
+  if (hints.length) {
+    lines.push('');
+    lines.push(yellow('Hint:'));
+    hints.forEach((h) => lines.push(dim(`  • ${h}`)));
+  }
+
+  return lines.join('\n');
+}
+
+/**
+ * 输出错误并退出
+ */
+export function printApiError(err, opts = {}) {
+  console.error(formatApiError(err, opts));
+  process.exit(1);
+}
+
+/**
+ * 输出简单错误（无 API 上下文，如 NOT_LOGGED_IN、FILE_NOT_FOUND）
+ */
+export function printSimpleError(message, hint = null) {
+  console.error(red(`Error: ${message}`));
+  if (hint) console.error(dim(`Hint: ${hint}`));
+  process.exit(1);
+}

package/src/lib/uploadSkill.js

@@ -1,91 +1,93 @@
-import path from 'path';
-import fs from 'fs-extra';
-import { createApiClient, getToken } from './auth.js';
-
-const validCategories = ['ai', 'data', 'web', 'devops', 'security', 'tools'];
-
-/**
- * Find uploadable file in cwd
- * Priority: SKILL.md, skill.zip, skill.tar.gz, dist.zip
- */
-export async function findUploadFile(cwd = process.cwd()) {
-  const candidates = [
-    path.join(cwd, 'SKILL.md'),
-    path.join(cwd, 'skill.zip'),
-    path.join(cwd, 'skill.tar.gz'),
-    path.join(cwd, 'dist.zip'),
-  ];
-  for (const p of candidates) {
-    if (await fs.pathExists(p)) {
-      const stat = await fs.stat(p);
-      if (stat.isFile()) return p;
-    }
-  }
-  return null;
-}
-
-/**
- * Upload skill file (SKILL.md, .zip, .tar.gz) to BotSkill
- * @param {string} filePath - Path to file
- */
-export async function uploadSkillFile(filePath) {
-  const token = getToken();
-  if (!token) {
-    throw new Error('NOT_LOGGED_IN');
-  }
-
-  if (!await fs.pathExists(filePath)) {
-    throw new Error('FILE_NOT_FOUND');
-  }
-
-  const FormData = (await import('form-data')).default;
-  const form = new FormData();
-  form.append('file', await fs.createReadStream(filePath), {
-    filename: path.basename(filePath),
-  });
-
-  const api = createApiClient();
-  const res = await api.post('/skills/upload', form, {
-    headers: form.getHeaders(),
-    maxBodyLength: Infinity,
-    maxContentLength: Infinity,
-  });
-  return res.data?.skill || res.data;
-}
-
-/**
- * Legacy: upload via JSON (for backward compatibility, may be deprecated)
- */
-export async function uploadSkill(options = {}) {
-  const token = getToken();
-  if (!token) throw new Error('NOT_LOGGED_IN');
-
-  let config = {};
-  const configPath = path.join(process.cwd(), 'skill.config.json');
-  if (await fs.pathExists(configPath)) {
-    config = await fs.readJson(configPath);
-  }
-
-  const skillData = {
-    name: options.name || config.name,
-    description: options.description || config.description,
-    version: options.version || config.version || '1.0.0',
-    category: options.category || config.category || 'tools',
-    tags: config.tags || [],
-    license: config.license || 'MIT',
-    repositoryUrl: config.repositoryUrl || undefined,
-    documentationUrl: config.documentationUrl || undefined,
-    demoUrl: config.demoUrl || undefined,
-  };
-
-  if (!skillData.name || !skillData.description) throw new Error('MISSING_FIELDS');
-  if (!validCategories.includes(skillData.category)) {
-    throw new Error(`Invalid category. Must be one of: ${validCategories.join(', ')}`);
-  }
-
-  const api = createApiClient();
-  const res = await api.post('/skills', skillData);
-  return res.data?.skill || res.data;
-}
-
-export { validCategories };
+import path from 'path';
+import fs from 'fs-extra';
+import { createApiClient, getToken } from './auth.js';
+
+const validCategories = ['ai', 'data', 'web', 'devops', 'security', 'tools'];
+
+/**
+ * Find uploadable file in cwd
+ * Priority: SKILL.md, skill.zip, skill.tar.gz, dist.zip
+ */
+export async function findUploadFile(cwd = process.cwd()) {
+  const candidates = [
+    path.join(cwd, 'SKILL.md'),
+    path.join(cwd, 'skill.zip'),
+    path.join(cwd, 'skill.tar.gz'),
+    path.join(cwd, 'dist.zip'),
+  ];
+  for (const p of candidates) {
+    if (await fs.pathExists(p)) {
+      const stat = await fs.stat(p);
+      if (stat.isFile()) return p;
+    }
+  }
+  return null;
+}
+
+/**
+ * Upload skill file (SKILL.md, .zip, .tar.gz) to BotSkill
+ * @param {string} filePath - Path to file
+ * @param {Object} [opts] - 可选
+ * @param {string} [opts.apiUrl] - 覆盖 API 地址（来自 --api-url）
+ */
+export async function uploadSkillFile(filePath, opts = {}) {
+  const token = getToken();
+  if (!token) {
+    throw new Error('NOT_LOGGED_IN');
+  }
+
+  if (!await fs.pathExists(filePath)) {
+    throw new Error('FILE_NOT_FOUND');
+  }
+
+  const FormData = (await import('form-data')).default;
+  const form = new FormData();
+  form.append('file', await fs.createReadStream(filePath), {
+    filename: path.basename(filePath),
+  });
+
+  const api = createApiClient(opts.apiUrl);
+  const res = await api.post('/skills/upload', form, {
+    headers: form.getHeaders(),
+    maxBodyLength: Infinity,
+    maxContentLength: Infinity,
+  });
+  return res.data?.skill || res.data;
+}
+
+/**
+ * Legacy: upload via JSON (for backward compatibility, may be deprecated)
+ */
+export async function uploadSkill(options = {}) {
+  const token = getToken();
+  if (!token) throw new Error('NOT_LOGGED_IN');
+
+  let config = {};
+  const configPath = path.join(process.cwd(), 'skill.config.json');
+  if (await fs.pathExists(configPath)) {
+    config = await fs.readJson(configPath);
+  }
+
+  const skillData = {
+    name: options.name || config.name,
+    description: options.description || config.description,
+    version: options.version || config.version || '1.0.0',
+    category: options.category || config.category || 'tools',
+    tags: config.tags || [],
+    license: config.license || 'MIT',
+    repositoryUrl: config.repositoryUrl || undefined,
+    documentationUrl: config.documentationUrl || undefined,
+    demoUrl: config.demoUrl || undefined,
+  };
+
+  if (!skillData.name || !skillData.description) throw new Error('MISSING_FIELDS');
+  if (!validCategories.includes(skillData.category)) {
+    throw new Error(`Invalid category. Must be one of: ${validCategories.join(', ')}`);
+  }
+
+  const api = createApiClient();
+  const res = await api.post('/skills', skillData);
+  return res.data?.skill || res.data;
+}
+
+export { validCategories };