Sysadmin Handbook
Sysadmin Handbook v2.0.0 — a thorough sysops toolkit for system administrators. Record, track, and manage all aspects of system administration from the command line. Every action is timestamped and logged locally for full auditability.
Why Sysadmin Handbook?
- - Works entirely offline — your data never leaves your machine
- Simple command-line interface, no GUI needed
- Timestamped logging for every operation
- Export to JSON, CSV, or plain text anytime
- Automatic history and activity tracking
- Searchable records across all operation types
Getting Started
CODEBLOCK0
Commands
Operations Commands
Each command works in two modes: run without arguments to view recent entries, or pass input to record a new entry.
| Command | Description |
|---|
| INLINECODE0 | Record a scan operation (port scans, vulnerability scans, network sweeps) |
| INLINECODE1 |
Log monitoring observations (service health, uptime checks, resource usage) |
|
sysadmin-handbook report <input> | Create report entries (incident reports, audit summaries, status updates) |
|
sysadmin-handbook alert <input> | Record alert events (threshold breaches, security warnings, service failures) |
|
sysadmin-handbook top <input> | Log top-level metrics (CPU hogs, memory consumers, disk leaders) |
|
sysadmin-handbook usage <input> | Track usage data (disk usage, bandwidth, API calls, license counts) |
|
sysadmin-handbook check <input> | Record health checks (service checks, config validation, dependency tests) |
|
sysadmin-handbook fix <input> | Document fixes applied (patches, config changes, workarounds) |
|
sysadmin-handbook cleanup <input> | Log cleanup operations (temp files, old logs, orphaned processes) |
|
sysadmin-handbook backup <input> | Track backup operations (full backups, incrementals, snapshots) |
|
sysadmin-handbook restore <input> | Record restore operations (data recovery, config rollbacks) |
|
sysadmin-handbook log <input> | General-purpose log entries (freeform notes, observations) |
|
sysadmin-handbook benchmark <input> | Record benchmark results (performance tests, load tests, I/O benchmarks) |
|
sysadmin-handbook compare <input> | Log comparison data (before/after, environment diffs, config comparisons) |
Utility Commands
| Command | Description |
|---|
| INLINECODE14 | Show summary statistics across all log categories |
| INLINECODE15 |
Export all data (formats:
json,
csv,
txt) |
|
sysadmin-handbook search <term> | Search across all entries for a keyword |
|
sysadmin-handbook recent | Show the 20 most recent history entries |
|
sysadmin-handbook status | Health check — version, data dir, entry count, disk usage |
|
sysadmin-handbook help | Show the built-in help message |
|
sysadmin-handbook version | Print version (v2.0.0) |
Data Storage
All data is stored locally in ~/.local/share/sysadmin-handbook/. Structure:
- -
scan.log, monitor.log, report.log, etc. — one log file per command, pipe-delimited (timestamp|value) history.log — unified activity log across all commandsexport.json / export.csv / export.txt — generated export files
Each entry is stored as YYYY-MM-DD HH:MM|<input>. Use export to back up your data anytime.
Requirements
- - Bash 4+ (uses
set -euo pipefail) - Standard Unix utilities (
date, wc, du, tail, grep, sed, cat) - No external dependencies or internet access needed
When to Use
- 1. Incident response tracking — Log scan results, alerts, and fixes during an active incident so you have a complete timeline for the post-mortem
- Daily ops journaling — Record monitoring observations, health checks, and cleanup tasks as you go through your sysadmin routine
- Backup & restore auditing — Track every backup and restore operation with timestamps to prove compliance or diagnose failures
- Performance benchmarking — Store benchmark results over time and use
compare to track regressions or improvements across deploys - Team handoff documentation — Log everything during your shift so the next admin can run
recent or search to get up to speed instantly
Examples
CODEBLOCK1
Output
All commands output to stdout. Redirect to a file if needed:
CODEBLOCK2
Configuration
Set SYSADMIN_HANDBOOK_DIR environment variable to override the default data directory (~/.local/share/sysadmin-handbook/).
Powered by BytesAgain | bytesagain.com | hello@bytesagain.com
系统管理员手册
系统管理员手册 v2.0.0 — 面向系统管理员的全面运维工具包。通过命令行记录、跟踪和管理系统管理的各个方面。每个操作都会添加时间戳并本地记录日志，确保完全可审计。
为什么选择系统管理员手册？
- - 完全离线工作 — 您的数据永远不会离开您的机器
- 简单的命令行界面，无需图形界面
- 每个操作都带有时间戳日志记录
- 随时导出为 JSON、CSV 或纯文本格式
- 自动历史和活动跟踪
- 跨所有操作类型的可搜索记录
快速开始
bash
查看所有可用命令
sysadmin-handbook help
检查当前健康状态
sysadmin-handbook status
查看摘要统计信息
sysadmin-handbook stats
命令
操作命令
每个命令有两种工作模式：不带参数运行以查看最近条目，或传递输入以记录新条目。
| 命令 | 描述 |
|---|
| sysadmin-handbook scan <输入> | 记录扫描操作（端口扫描、漏洞扫描、网络扫描） |
| sysadmin-handbook monitor <输入> |
记录监控观察结果（服务健康状态、运行时间检查、资源使用情况） |
| sysadmin-handbook report <输入> | 创建报告条目（事件报告、审计摘要、状态更新） |
| sysadmin-handbook alert <输入> | 记录告警事件（阈值突破、安全警告、服务故障） |
| sysadmin-handbook top <输入> | 记录顶级指标（CPU 占用、内存消耗、磁盘占用） |
| sysadmin-handbook usage <输入> | 跟踪使用数据（磁盘使用量、带宽、API 调用、许可证数量） |
| sysadmin-handbook check <输入> | 记录健康检查（服务检查、配置验证、依赖测试） |
| sysadmin-handbook fix <输入> | 记录已应用的修复（补丁、配置更改、临时解决方案） |
| sysadmin-handbook cleanup <输入> | 记录清理操作（临时文件、旧日志、孤立进程） |
| sysadmin-handbook backup <输入> | 跟踪备份操作（完整备份、增量备份、快照） |
| sysadmin-handbook restore <输入> | 记录恢复操作（数据恢复、配置回滚） |
| sysadmin-handbook log <输入> | 通用日志条目（自由格式笔记、观察结果） |
| sysadmin-handbook benchmark <输入> | 记录基准测试结果（性能测试、负载测试、I/O 基准测试） |
| sysadmin-handbook compare <输入> | 记录比较数据（前后对比、环境差异、配置比较） |
实用命令
| 命令 | 描述 |
|---|
| sysadmin-handbook stats | 显示所有日志类别的摘要统计信息 |
| sysadmin-handbook export <格式> |
导出所有数据（格式：json、csv、txt） |
| sysadmin-handbook search <关键词> | 在所有条目中搜索关键词 |
| sysadmin-handbook recent | 显示最近 20 条历史记录 |
| sysadmin-handbook status | 健康检查 — 版本、数据目录、条目数量、磁盘使用量 |
| sysadmin-handbook help | 显示内置帮助信息 |
| sysadmin-handbook version | 打印版本号（v2.0.0） |
数据存储
所有数据本地存储在 ~/.local/share/sysadmin-handbook/ 目录下。结构如下：
- - scan.log、monitor.log、report.log 等 — 每个命令对应一个日志文件，以管道符分隔（时间戳|值）
- history.log — 所有命令的统一活动日志
- export.json / export.csv / export.txt — 生成的导出文件
每个条目存储格式为 YYYY-MM-DD HH:MM|<输入>。随时使用 export 命令备份数据。
系统要求
- - Bash 4+（使用 set -euo pipefail）
- 标准 Unix 工具（date、wc、du、tail、grep、sed、cat）
- 无需外部依赖或互联网访问
使用场景
- 1. 事件响应跟踪 — 在活跃事件期间记录扫描结果、告警和修复操作，以便事后分析时拥有完整的时间线
- 日常运维日志 — 在执行系统管理员日常工作时记录监控观察结果、健康检查和清理任务
- 备份与恢复审计 — 跟踪每次备份和恢复操作并添加时间戳，以证明合规性或诊断故障
- 性能基准测试 — 存储随时间变化的基准测试结果，并使用 compare 命令跟踪部署间的性能退化或改进
- 团队交接文档 — 在值班期间记录所有操作，以便下一位管理员可以运行 recent 或 search 命令快速了解情况
示例
bash
记录网络扫描结果
sysadmin-handbook scan 192.168.1.0/24 — 14 台主机在线，3 台开放 SSH
记录监控观察结果
sysadmin-handbook monitor web-prod-01 CPU 在 92% 持续 15 分钟
记录应用的修复
sysadmin-handbook fix 将 nginx worker_connections 从 1024 增加到 4096
跟踪备份操作
sysadmin-handbook backup /data 完整备份完成 — 48GB，耗时 23 分钟
将所有数据导出为 JSON 格式进行归档
sysadmin-handbook export json
在所有日志中搜索关键词
sysadmin-handbook search nginx
查看所有命令的最近活动
sysadmin-handbook recent
输出
所有命令输出到标准输出。如果需要，可以重定向到文件：
bash
sysadmin-handbook stats > report.txt
sysadmin-handbook export csv
配置
设置 SYSADMINHANDBOOKDIR 环境变量以覆盖默认数据目录（~/.local/share/sysadmin-handbook/）。
由 BytesAgain 提供 | bytesagain.com | hello@bytesagain.com
