buckyos-devkit

buckyos-devkit 是 BuckyOS 共用的开发脚本基础库。支持用如下方法使用：

快速开始

安装

从 GitHub 安装（项目发布后）:

pip install --force-reinstall "buckyos-devkit @ git+https://github.com/buckyos/buckyos-devkit.git"

📝 --force-reinstall 首次安装也可以使用，避免缓存导致 buckyos-devkit 版本未更新。

本地开发安装（当前推荐）:

# 1. 创建并激活虚拟环境
cd /Users/liuzhicong/project/buckyos-devkit
python3 -m venv test_devkit
source test_devkit/bin/activate

# 2. 安装包（可编辑模式）
pip3 install -e .

# 3. 验证安装
python3 test_installation.py

📝 详细的本地安装步骤和故障排除，请参考 LOCAL_INSTALL.md

命令行工具

安装后会提供以下命令行工具：

• buckyos-build - 构建工具
• buckyos-install - 安装工具
• buckyos-remote - 远程管理工具

远程安装

buckyos-install 可以通过系统的 ssh 和 scp 把当前构建产物安装到远程 POSIX 主机：

# 默认更新模块/二进制
buckyos-install --remote 192.0.2.10 --ssh-user root

# 首次完整安装；目标目录不存在或为空时无需确认
buckyos-install --all --remote 192.0.2.10 --ssh-user deploy --sudo

# 对已有安装执行完整重装时会交互确认；自动化环境可显式确认
buckyos-install --all --remote 192.0.2.10 --ssh-user deploy --sudo --yes

可用的连接参数包括 --ssh-port、--ssh-key，以及可重复传入的 --ssh-option（例如 --ssh-option ProxyJump=bastion）。--remote 也接受 USER@HOST。使用 --sudo 时，远程账号必须能够执行免密 sudo。

Rust 版本信息注入

buckyos-build 在编译时会注入以下环境变量，可用于输出完整版本信息：

• BUCKYOS_BUILD_DATE (YYYY-MM-DD)
• BUCKYOS_BUILD_TIMESTAMP (UTC ISO-8601)
• BUCKYOS_GIT_COMMIT
• BUCKYOS_GIT_BRANCH
• BUCKYOS_GIT_DESCRIBE
• BUCKYOS_GIT_DIRTY (0/1)

Rust 示例：

const BUILD_DATE: &str = env!("BUCKYOS_BUILD_DATE");
const GIT_COMMIT: &str = env!("BUCKYOS_GIT_COMMIT");
const GIT_BRANCH: &str = env!("BUCKYOS_GIT_BRANCH");

在代码中使用

from buckyos_devkit import util

# 使用工具函数
root = util.get_buckyos_root()
util.check_process_exists("/path/to/process")

详细文档

更多使用示例和详细说明，请参考 USAGE_EXAMPLE.md

功能特性

• 🔨 构建工具: 支持多平台构建（Linux、Windows、macOS）
• 📦 安装工具: 自动化安装和配置
• 🌐 远程管理: 虚拟机和远程设备管理
• 🛠️ 工具函数: 进程管理、端口检查等实用工具

依赖

• Python >= 3.8
• PyYAML >= 6.0
• Paramiko >= 3.0.0
• Requests >= 2.28.0