logger 仓库中文介绍文档

logger 是一个用于Prompt/LLM工程的最小可行日志记录器，由 smol-ai 提供，通过将IDE作为日志UI，为开发提供快速、简单、可扩展的Node.js日志工具，支持从开发环境轻松扩展到生产环境。

要点：

开头就要说清楚：这是什么工具、解决什么问题
包含Stars数（如有）、维护者信息
1-3句话，简洁有力

示例： OpenBB 是一款面向金融分析师、量化交易员与 AI 智能体的开源金融数据平台，以"一次连接、随处消费"为核心架构，统一接入股票、期权、加密等多资产数据。

一、核心信息速览

维度	详情
:---	:---
仓库地址	[logger](https://github.com/smol-ai/logger)
许可证	MIT License
核心定位	用于Prompt/LLM工程的最小可行日志记录器
主要语言	TypeScript
适用人群	LLM开发者、Prompt工程师、全栈开发者
关键亮点	快速简单；零依赖；可扩展；支持终端和文件系统日志

二、核心功能

功能模块	描述	典型场景
:---	:---	:---
日志记录	默认同时记录到终端和本地JSON文件，便于导航和版本控制	开发过程中实时查看日志
Prompt/Response对捕获	支持包装和转换异步调用，清晰捕捉Prompt与Response	在Prompt工程中跟踪对话历史
CLI导出	提供CLI工具将JSON日志编译为TSV文件，方便导入电子表格	使用Google Sheets或Excel分析日志
可扩展性	支持将日志持久化到远程存储如Logflare，自定义命名、缩进和颜色	扩展至生产环境使用
零依赖	核心代码小于100行，比Winston和Bunyan更快	轻量级工具，适合快速集成
TypeScript支持	提供类型定义，提升开发体验	增强代码安全性和可维护性
自动时间追踪	自动记录时间流逝、文件路径、行号和日志调用顺序	便于调试和性能分析
清理日志	通过删除`.logs`文件清除日志（可配置）	管理日志存储空间

三、快速上手

1. 环境准备

Node.js 16+ 和 npm 8+

2. 安装方式

npm install @smol-ai/logger

3. 基础配置

创建一个SmolLogger实例并指定是否记录到控制台和文件系统。

4. 核心示例

import { SmolLogger } from '@smol-ai/logger';

const logger = new SmolLogger({ logToConsole: true, logToStore: true });
const log = logger.log;

log('name of log (required)', { key: 'value' });

四、核心亮点

快速简单：无需复杂配置，开箱即用。
零依赖：核心代码小于100行，轻量高效。
可扩展性强：支持远程存储和自定义格式。
TypeScript支持：增强代码类型安全性和可维护性。
终端与文件系统双记录：便于开发和调试。
Prompt/Response对捕获：适用于Prompt工程和LLM应用。

五、适用场景

LLM开发：用于记录模型训练和推理过程中的关键信息。
Prompt工程：帮助跟踪和分析Prompt与响应之间的关系。
全栈开发：在开发环境中快速调试和记录日志。
生产环境扩展：通过远程存储支持日志管理。
轻量级项目：不需要复杂日志框架的小型项目。

六、优缺点

优势

零依赖，轻量高效
支持终端和文件系统双记录
易于扩展，支持远程存储
提供TypeScript支持，增强代码安全性

不足

无日志级别，无法区分严重程度
目前不支持浏览器端运行，需要额外适配

七、与同类工具对比（可选）

工具	类型	核心差异
:---	:---	:---
logger	开源日志工具	零依赖，轻量且易于扩展
Winston	日志库	功能丰富但依赖较多，配置复杂
Bunyan	日志库	专注于结构化日志，但缺乏灵活性