Shell 脚本模板

一个现代 Bash 脚本模板，具有彩色输出格式和实用函数，用于创建专业的命令行工具。

功能特性

• 🎨 彩色输出：预定义的颜色方案和格式化函数
• 📝 标准化消息：一致的信息、成功、警告和错误消息格式
• 🔧 实用函数：可直接用于常见 shell 脚本操作的现成函数
• 📦 模块化设计：独立的库文件，便于在项目中重复使用
• ⚡ 易于设置：简单的 source 机制即可立即使用

快速开始

1. 克隆或下载此模板
2. 使你的脚本可执行：
   root@kitploit:~

   chmod +x script.sh
   

3. 运行示例脚本：
   root@kitploit:~

   ./script.sh
   

用法

基本模板结构

#!/bin/bash

LIB="lib"
source $LIB/format.sh

section "Your Script Section"
info "Information message"
ok "Success message" 
warn "Warning message"
error "Error message"

可用函数

消息类型

• info "message" - 显示带有青色 [i] 前缀的信息消息
• ok "message" - 显示带有绿色 [+] 前缀的成功消息
• warn "message" - 显示带有黄色 [!] 前缀的警告消息
• error "message" - 显示带有红色 [-] 前缀的错误消息（发送到 stderr）

交互函数

• prompt "question" - 显示带有洋红色 [?] 前缀的提示，并等待用户输入
• section "title" - 创建一个格式化的部分标题

文本格式化

• bold "text" - 以粗体格式显示文本

颜色常量

以下颜色常量可用于自定义格式：

RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
MAGENTA='\033[0;35m'
CYAN='\033[0;36m'
WHITE='\033[1;37m'
BOLD='\033[1m'
UNDERLINE='\033[4m'
RESET='\033[0m'

示例输出

当您运行示例脚本时，您将看到：

=== Start ===
[i] Running exploit setup...
[+] Everything is ready
[!] This might break your system
[-] Something failed
[?] Continue? [y/N]:

文件结构

shell_template/
├── script.sh          # Example script demonstrating usage
├── lib/
│   └── format.sh       # Core formatting library
├── LICENSE             # MIT License
└── README.md          # This file

自定义

添加新消息类型

您可以在 lib/format.sh 中添加新的消息类型来扩展库：

DEBUG="${BLUE}[D]${RESET}"
debug() { echo -e "${DEBUG} $*"; }

自定义颜色

通过修改颜色常量或创建新颜色来定义您自己的配色方案：

PURPLE='\033[0;35m'
CUSTOM_PREFIX="${PURPLE}[*]${RESET}"
custom() { echo -e "${CUSTOM_PREFIX} $*"; }

最佳实践

1. 始终引用库：在脚本开头包含 source $LIB/format.sh
2. 使用合适的消息类型：根据上下文选择合适的函数（info、ok、warn、error）
3. 使用部分结构：使用 section 来组织脚本输出
4. 正确处理错误：对错误消息使用 error 并重定向到 stderr
5. 使脚本可执行：不要忘记对脚本执行 chmod +x

贡献

欢迎提交 issue、fork 仓库，并为任何改进创建拉取请求。

许可证

本项目采用 MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件。

作者

由 Christoph Huy 创建