使用说明
不再站立
自动化您的站立,为有意义的工作节省时间。
概述
No More Standups是一个帮助您自动创建和管理standup更新的工具。它使用AI通过分析您的git提交、JIRA/GitHub问题和其他工作工件来生成有意义的、上下文感知的状态更新。
安装
先决条件
- Node.js 18+
- pnpm 10+
设置
-
克隆存储库:
git clone https://github.com/your-username/no-more-standups.git cd no-more-standups -
安装依赖项:
pnpm install -
构建包:
pnpm build
全球安装(用于开发)
要在开发过程中全局使用CLI:
cd packages/cli
pnpm link --global
然后,您可以使用 nms 从任何地方发出命令。
用法
运行CLI
构建包后,您可以直接运行CLI:
node packages/cli/dist/index.js
注意:您需要先创建一个配置文件(请参阅下面的配置部分),否则将出现“找不到配置文件”错误。
开发命令
对于开发,请从项目根目录使用以下命令:
# From the root directory
pnpm build # Build all packages
pnpm test # Run tests
pnpm lint # Run linting
pnpm format # Format code
pnpm cli:dev # Run the CLI in dev mode (recommended)
或者,您可以直接从CLI包运行dev命令:
# From the CLI package directory
cd packages/cli
pnpm dev
配置
在运行CLI之前,请在以下位置创建配置文件 ~/.nms/config.json 具有以下结构:
{
"llmProvider": {
"apiKey": "your-api-key",
"model": "gpt-4",
"provider": "openai"
},
"user": {
"name": "Your Name",
"email": "your-email@example.com"
}
}
您可以通过以下方式创建此文件:
mkdir -p ~/.nms
然后创建文件 ~/.nms/config.json 使用编辑器,或使用:
cat > ~/.nms/config.json << EOF
{
"llmProvider": {
"apiKey": "your-api-key",
"model": "gpt-4",
"provider": "openai"
},
"user": {
"name": "Your Name",
"email": "your-email@example.com"
}
}
EOF
支持的提供商:
openaigeminiclaude
发展
项目结构
no-more-standups/
├─ packages/
│ ├─ cli/ # Command-line interface
│ │ ├─ src/
│ │ └─ ...
│ └─ core/ # Core functionality
│ ├─ src/
│ └─ ...
└─ ...
可用脚本
-
构建所有包:
pnpm build -
运行测试:
pnpm test -
棉绒编码:
pnpm lint -
格式代码:
pnpm format
地方发展
- 对源代码进行更改
- 构建包:
pnpm build - 测试您的更改:
pnpm test
测试
使用以下命令运行测试套件:
pnpm test
添加依赖关系
-
向特定包添加依赖关系:
pnpm --filter @no-more-standups/core add <package-name> -
在根目录中添加开发依赖项:
pnpm add -D <package-name>
故障排除
如果在生成的文件中遇到linting错误:
pnpm format
如果您在.ts文件中遇到关于未知文件扩展名的错误,请使用:
# From the root directory
pnpm cli:dev
此命令将在开发模式下正确执行CLI。
许可证
该项目根据ISC许可证获得许可。