笔记CLI工具

一个基于TypeScript的小型CLI项目,用于编译和运行笔记管理工具。

  • by themeselection
  • JavaScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 themeselection/notes-mcp-demo

使用说明

注释mcp

一个基于TypeScript的小型CLI项目 ./build 并暴露出a notes-mcp 二元的。

需求

  • Node.js(推荐LTS)
  • npm

安装

安装依赖项:

npm install

构建

将TypeScript源代码编译到 build/ 文件夹:

npm run build

这 build 脚本(来自 package.json)运行TypeScript编译器,并在生成的CLI包上设置可执行权限:

tsc && chmod 755 build/index.js

跑

  • 直接使用Node运行构建的CLI:
node build/index.js
  • 或者在开发过程中使CLI在系统范围内可用:
npm link
# then run
notes-mcp

项目结构

  • package.json -项目清单(包括 build 脚本和 bin 映射)
  • tsconfig.json -TypeScript配置
  • src/ -TypeScript源文件
    • src/index.ts -主入口
    • src/utils.ts -助手
  • build/ -编译输出(通过提交 files 列表)
    • build/index.js -编译的CLI条目
    • build/utils.js -编译助手

发展

  • 编辑文件 src/ 并重新运行 npm run build 更新 build/.
  • 类型定义可通过以下方式获得 @types/node 在 devDependencies.

出版/包装

该套餐仅包括 build/ 文件夹(请参见 files 在 package.json).发布前,请确保 build/ 包含已编译和可执行文件 index.js.

贡献

欢迎捐款。打开一个问题或提交一个拉取请求,并明确描述更改。

许可证

该项目根据 ISC 许可证(参见 package.json).