adobe/slh

Sledgehammer

概述

Sledgehammer是一个围绕Docker的轻量级包装器，提供在Docker容器中执行的原生工具。它旨在支持依赖隔离执行，减少本地安装工具的需求，让用户可以像使用本地安装的工具一样使用Docker化工具。

核心功能和特性

• 依赖隔离：通过Docker容器隔离工具依赖，避免本地环境污染
• 原生工具体验：创建工具符号链接，可直接通过工具名称调用，无需额外Docker命令
• 版本化工具支持：支持同一工具的多个版本，默认遵循语义化版本选择最新版本
• 内置注册表：默认包含"default"注册表，提供多种工具和工具包
• 简单安装：通过Docker命令引导完成安装，仅需挂载Docker socket和本地可执行路径

安装步骤

前提条件

• Docker API版本需1.35或更高
• 具有Docker socket访问权限

安装流程

安装Sledgehammer需两步：挂载Docker socket和传递本地可执行路径。

步骤1：挂载Docker socket

在大多数系统中，可通过以下命令挂载Docker socket：

bash
docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock adobe/slh

注意：如有需要，也可传递DOCKER_HOST环境变量。

步骤2：挂载本地可执行目录

需将本地目录（应在PATH中）挂载到容器的/bin目录：

bash
docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock -v <localPath>:/bin adobe/slh

安装过程中，Sledgehammer会提供具体指引，完成后即可使用。

使用方法

安装完成后，slh可执行文件（安装路径需在PATH中）即可使用。

基本命令格式

slh [command]

可用命令

• create：创建资源
• delete：删除资源
• describe：描述资源详细信息
• get：获取资源列表
• help：获取命令帮助
• install：安装工具到系统
• reset：重置别名
• update：更新所有注册表

标志选项

• --confdir string：配置目录位置，默认为bindir/.slh
• -h, --help：显示帮助信息
• --log-level string：设置日志级别（debug|info|warning|error|fatal|panic），默认为"none"
• -o, --output string：定义输出格式，支持text|json，默认为"text"
• --version：显示版本信息

使用slh [command] --help获取特定命令的详细信息。

快速开始

查看可用资源

Sledgehammer使用注册表概念，每个注册表包含多个工具和工具包。默认提供"default"注册表，可通过以下命令查看可用工具：

bash
slh get tools

同样可查看注册表、工具包和挂载：

bash
slh get registries
slh get kits
slh get mounts

安装工具

使用install命令安装工具：

bash
slh install <toolname> <flags>

安装后会创建工具名称的符号链接，可直接调用：

bash
<toolname> <arguments>

版本控制

Sledgehammer支持版本化工具，可同时安装同一工具的多个版本。默认遵循语义化版本选择最新版本。例如，对于版本latest、1.0.0、1.2.0，默认使用1.2.0。详细信息参见版本控制文档。

构建与运行

使用Docker和Make构建

需安装Docker和Make：

bash
make pr     # 测试项目
make ci     # 构建Docker镜像

构建完成后会生成本地adobe/slh镜像，可按上述安装步骤进行安装。

使用Go构建

作为Go项目，可将仓库放在有效的Go路径（<GOPATH>/src/github.com/adobe/sledgehammer），执行测试：

bash
go test ./...

构建安装程序：

bash
cd installer && go build

构建slh可执行文件：

bash
cd slh && go build

贡献

欢迎贡献！详情参见贡献指南。

许可

本项目采用Apache V2许可证。详见LICENSE。