BEISER901/bscript-cli

# BScript-CLI **支持动态加载命令的交互式命令行脚本解释器** BScript 是一个基于 Node.js 的强大命令行界面框架，允许你创建具有动态加载命令、基于权限的访问控制以及内置命令历史管理功能的交互式终端应用程序。 [](https://nodejs.org/) [](https://www.npmjs.com/package/bscript) [](./LICENSE) ## ✨ 核心功能 ## 📌 实用链接 | 链接 | 描述 | |------|-------------| | **[语法参考](https://github.com/BEISER901/bscript-runner/blob/main/Docs/BScript/SYNTAX.md)** | BScript 语言语法的完整参考。 | | **[CLI 参考](./BScript/BSCRIPT-REFERENCE-CLI.md)** | 可用的 BScript 命令及其声明。 | | **[bscript-runner](https://github.com/BEISER901/bscript-runner)** | bscript-runner 跨平台编译器。 | | **[入门指南](./TUTORIAL.md)** | 安装与初步操作步骤 | | **[API 参考](./REFERENCE.md)** | 完整的公共 API 文档 | | **[技术文档](./TECHNICAL.md)** | 内部架构与实现细节 | ## 🚀 快速开始 ### 安装 #### 全局安装 **使用 npm** ``` npm install -g @beiser/bscript-cli ``` **使用 pnpm** ``` pnpm add -g @beiser/bscript-cli ``` **使用 yarn** ``` yarn global add @beiser/bscript-cli ``` #### 本地安装 **使用 npm** ``` npm install @beiser/bscript-cli ``` **使用 pnpm** ``` pnpm add @beiser/bscript-cli ``` **使用 yarn** ``` yarn add @beiser/bscript-cli ``` ### 基本用法 ``` const BScript = require("@beiser/bscript-cli"); // Create a new BScript instance const cmd = new BScript(); // Set default permissions cmd.cmdRootPermissions = [cmd.perrmissionsKeys.default]; // Load commands from default locations cmd.updateCommands(); // Start interactive mode cmd.Start(); ``` ### 命令行界面 ``` # 启动交互模式 bscript # 执行 inline script bscript -e "your script code" # 加载并执行脚本文件 bscript script path/to/file.js # 显示帮助 bscript --help # 显示版本 bscript --version ``` ### 入门指南 1. 通过 npm 安装该包 2. 使用所需的配置创建一个 BScript 实例 3. 在你的 commands 目录下的 `.js` 文件中定义命令 4. 更新命令以将它们加载到系统中 5. 启动交互式界面或执行脚本 完整指南请参阅 **[TUTORIAL.md](./TUTORIAL.md)**。 ## 📚 文档 - **[入门指南](./TUTORIAL.md)** — 安装与使用指南 - **[API 参考](./REFERENCE.md)** — 完整的公共 API 文档 - **[技术文档](./TECHNICAL.md)** — 架构与内部实现细节 ## 🛠 核心模块 - **BScript** — 用于管理命令、权限和终端交互的主类 - **TerminalCommandController** — 处理终端 I/O 和用户输入解析 - **BScriptHistory** — 管理跨会话的持久化命令历史 - **CMDPermissions** — 用于访问控制的权限常量 - **BScriptRunner** — 脚本执行引擎（外部依赖） ## 📦 环境要求 - Node.js **18+** - npm / pnpm / yarn ## 📄 许可证 本项目基于 **MIT License** 授权。 详情请参阅 **[LICENSE](./LICENSE)** 文件。 **用 ❤️ 为 Node.js 生态系统打造**

标签：CLI框架, GNU通用公共许可证, MITM代理, Node.js, Streamlit, 数据可视化, 暗色界面, 脚本解释器, 自定义脚本, 访问控制