{"id":20206561,"url":"https://github.com/zhinjs/cli","last_synced_at":"2025-08-04T12:06:41.761Z","repository":{"id":61409318,"uuid":"543387249","full_name":"zhinjs/cli","owner":"zhinjs","description":"cli for Zhin bot，知音机器人的命令行工具","archived":false,"fork":false,"pushed_at":"2024-01-28T03:10:29.000Z","size":153,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-13T21:17:35.402Z","etag":null,"topics":["bot","bot-framework","chatbot","cli","icqq","oicq","zhin"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zhinjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-30T01:37:32.000Z","updated_at":"2023-08-11T08:51:31.000Z","dependencies_parsed_at":"2023-02-09T02:40:11.615Z","dependency_job_id":null,"html_url":"https://github.com/zhinjs/cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"l-collect/ts-dev-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhinjs%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhinjs%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhinjs%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhinjs%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhinjs","download_url":"https://codeload.github.com/zhinjs/cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241644542,"owners_count":19996177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","bot-framework","chatbot","cli","icqq","oicq","zhin"],"created_at":"2024-11-14T05:24:53.204Z","updated_at":"2025-03-03T09:43:48.606Z","avatar_url":"https://github.com/zhinjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @zhinjs/cli\n\ncli for Zhin bot，知音机器人的命令行工具\n\n## Usage\n\n\u003e 初始化项目 `zhin init`\n\n1. 打开或新建一个项目文件夹\n2. 在项目文件夹下打开命令行(终端)窗口\n3. 执行 `zhin init [projectName]` (若未填项目名，将在当前文件夹初始化项目)\n4. 根据提示录入信息即可完成 zhin 初始化\n\n\u003e 启动项目 `zhin start`\n\n5. 在项目文件夹下打开命令行(终端)窗口\n6. 执行 `zhin start`\n7. 等待命令执行完毕即可启动 zhin\n\n   \u003e 【可选】添加插件 `zhin new \u003cpluginName\u003e`\n   \u003e\n   \u003e 若你有自己开发插件的意图，本指令可为你创建一个模板插件\n\n8. 在项目文件夹下打开命令行(终端)窗口\n9. 执行 `zhin new \u003cpluginName\u003e` (请将 `\u003cpluginName\u003e` 替换为你的插件名)\n10. 默认创建的插件为 JavaScript 语言开发，若你想创建一个 TypeScript 插件开发的模板，可添加 `-t` 声明其类型为 ts\n\n\u003e 【可选】发布你的插件 `zhin pub \u003cpluginName\u003e`\n\u003e\n\u003e 在插件开发完毕后，如果你又意愿将插件公开给其他 zhin 用户使用，可使用该命令将插件发布到npm 供他人下载\n\u003e\n\u003e 注意：ts 编写的插件在发布前需要使用 `zhin build \u003cpluginName\u003e 命令先将插件编译成可在 js 环境运行的插件,否则你的插件将只能在 cli 指令启动的 zhin 下运行\n\u003e\n\u003e 注意：若插件名与 npm 上已有的包名冲突且该包不是你所有，将无法上传\n\n1. 在项目文件夹下打开命令行(终端)窗口\n2. 执行 `zhin pub [pluginName]` (请将`[pluginName]`替换为你的插件名)\n3. 等待命令执行完成即可发布你的插件到 npm\n\n\u003e 【可选】编译插件 `zhin build \u003cpluginName\u003e`\n\u003e\n\u003e 将 ts 编写的插件编译成可在 js 环境运行的插件\n\n1. 在项目文件夹下打开命令行(终端)窗口\n2. 执行 `zhin build \u003cpluginName\u003e` (请将`\u003cpluginName\u003e`替换为你的插件名)\n3. 等待命令执行完成即可编译你的插件\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhinjs%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhinjs%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhinjs%2Fcli/lists"}