easy-command 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 UnionSchool
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,150 @@
+# easy-command
+
+One command to configure a polished Zsh terminal with Oh My Zsh, the `agnoster` theme, Git status, command suggestions, Tab completion, and syntax highlighting.
+
+> 一条命令配置统一的 Zsh 终端：Oh My Zsh、`agnoster` 主题、Git 状态、历史命令建议、Tab 补全与命令语法高亮。
+
+## Preview
+
+> 效果预览。
+
+### Git branch and working-tree status
+
+> Git 分支与工作区状态。
+
+![agnoster displays Git branch and working-tree status](assets/git-status.png)
+
+### History-based command suggestions
+
+> 历史命令自动建议。
+
+![A suggested history command appears while typing](assets/autosuggestions.png)
+
+### Syntax highlighting and error feedback
+
+> 命令语法高亮与错误提示。
+
+![Valid commands are green and unknown commands are red](assets/syntax-highlighting.png)
+
+## Quick start
+
+> 快速开始。
+
+Install the latest version:
+
+> 安装最新版本：
+
+```bash
+npx easy-command --yes
+```
+
+Or install directly from GitHub without Node.js/npm:
+
+> 或者无需 Node.js/npm，直接从 GitHub 安装：
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/UnionSchool/easy-command/main/install.sh | bash -s -- --yes
+```
+
+After installation, sign in again or run:
+
+> 安装完成后重新登录，或运行：
+
+```bash
+exec zsh -l
+```
+
+## What you get
+
+> 提供的能力。
+
+- `agnoster`: shows the user, current path, Git branch, and working-tree status.<br>
+  `agnoster`：显示用户名、路径、Git 分支和工作区状态。
+- `zsh-autosuggestions`: shows gray suggestions from command history; press `→` or `Ctrl+E` to accept.<br>
+  `zsh-autosuggestions`：从历史命令显示灰色建议，按 `→` 或 `Ctrl+E` 接受。
+- `zsh-syntax-highlighting`: valid commands are green; unknown commands are bold red.<br>
+  `zsh-syntax-highlighting`：有效命令绿色、未知命令红色加粗。
+- Native Zsh completion: press `Tab` to complete commands, paths, and Git subcommands; press it twice for candidates.<br>
+  Zsh 原生补全：按 `Tab` 补全命令、路径和 Git 子命令，连按两次显示候选项。
+- Shared history: the latest 10,000 commands are shared between terminal sessions.<br>
+  共享历史：多个终端会话共享最近 10,000 条命令。
+
+## Options
+
+> 参数。
+
+```bash
+# Configure a specific user / 指定目标用户
+bash install.sh --yes --user bell
+
+# Keep the current login shell / 不改变默认登录 Shell
+bash install.sh --yes --no-chsh
+
+# Remove only the configuration block managed by easy-command / 删除本工具管理的 .zshrc 区块
+bash install.sh --uninstall
+```
+
+## Supported platforms
+
+> 支持范围。
+
+- macOS: Homebrew must already be installed.<br>
+  macOS：要求已安装 Homebrew。
+- Ubuntu / Debian: dependencies are installed with `apt-get`.<br>
+  Ubuntu / Debian：使用 `apt-get` 安装依赖。
+
+The script needs `sudo` to install packages and change the default shell. Without sudo access, use `--no-chsh` and have an administrator install Zsh first.
+
+> 脚本需要 `sudo` 来安装软件包和切换默认 Shell。没有 sudo 权限时，可加 `--no-chsh`，并由管理员预先安装 Zsh。
+
+## Configuration and rollback
+
+> 配置与回退。
+
+Installed files:
+
+> 安装内容位于：
+
+```text
+~/.easy-command/oh-my-zsh
+~/.zshrc
+~/.zsh_history
+```
+
+Before each `.zshrc` update, the script creates a timestamped backup. `--uninstall` removes only the configuration block managed by easy-command; it does not remove Oh My Zsh, plugins, or other user settings.
+
+> 每次更新 `.zshrc` 前，脚本会创建带时间戳的备份。`--uninstall` 只删除由 easy-command 管理的配置块，不会删除 Oh My Zsh、插件或用户自己的其他配置。
+
+## Security
+
+> 安全说明。
+
+For a first-time trial, download and inspect the script before running it:
+
+> 首次试用建议先下载并审阅脚本：
+
+```bash
+curl -fsSLO https://raw.githubusercontent.com/UnionSchool/easy-command/main/install.sh
+less install.sh
+bash install.sh --yes
+```
+
+For production, pin a release tag instead of running `main` directly:
+
+> 生产环境建议固定到发布标签，而不是直接使用 `main`：
+
+```bash
+npx easy-command@1.0.4 --yes
+```
+
+Or, without npm:
+
+> 或者不使用 npm：
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/UnionSchool/easy-command/v1.0.4/install.sh | bash -s -- --yes
+```
+
+## License
+
+[MIT](LICENSE)

package/bin/easy-command

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -Eeuo pipefail
+
+source_path="${BASH_SOURCE[0]}"
+while [[ -h "$source_path" ]]; do
+    source_directory="$(cd -P "$(dirname "$source_path")" && pwd)"
+    source_path="$(readlink "$source_path")"
+    [[ "$source_path" == /* ]] || source_path="$source_directory/$source_path"
+done
+
+package_directory="$(cd -P "$(dirname "$source_path")/.." && pwd)"
+exec "$package_directory/install.sh" "$@"

package/install.sh

@@ -0,0 +1,200 @@
+#!/usr/bin/env bash
+
+set -Eeuo pipefail
+
+readonly VERSION='1.0.4'
+readonly BEGIN_MARKER='# >>> easy-command zsh >>>'
+readonly END_MARKER='# <<< easy-command zsh <<<'
+
+ASSUME_YES=false
+CHANGE_LOGIN_SHELL=true
+UNINSTALL=false
+TARGET_USER="${SUDO_USER:-${USER}}"
+
+info() { printf '\033[1;32m[easy-command]\033[0m %s\n' "$*"; }
+warn() { printf '\033[1;33m[easy-command]\033[0m %s\n' "$*" >&2; }
+fail() { printf '\033[1;31m[easy-command]\033[0m %s\n' "$*" >&2; exit 1; }
+
+usage() {
+    cat <<'EOF'
+Usage: install.sh [options]
+
+Options:
+  --yes, -y         Run without confirmation.
+  --user USER       Configure this user. Defaults to the invoking user.
+  --no-chsh         Do not change the user's default login shell to zsh.
+  --uninstall       Remove only the easy-command managed .zshrc block.
+  --help, -h        Show this help.
+EOF
+}
+
+while (($#)); do
+    case "$1" in
+        --yes|-y) ASSUME_YES=true ;;
+        --user)
+            shift
+            (($#)) || fail '--user requires a value.'
+            TARGET_USER="$1"
+            ;;
+        --no-chsh) CHANGE_LOGIN_SHELL=false ;;
+        --uninstall) UNINSTALL=true ;;
+        --help|-h)
+            usage
+            exit 0
+            ;;
+        *) fail "Unknown option: $1" ;;
+    esac
+    shift
+done
+
+TARGET_HOME="$(getent passwd "$TARGET_USER" | cut -d: -f6 2>/dev/null || true)"
+if [[ -z "$TARGET_HOME" && "$(uname -s)" == 'Darwin' ]]; then
+    TARGET_HOME="$(dscl . -read "/Users/$TARGET_USER" NFSHomeDirectory | awk '{print $2}')"
+fi
+[[ -n "$TARGET_HOME" && -d "$TARGET_HOME" ]] || fail "Cannot determine home directory for $TARGET_USER."
+
+run_as_root() {
+    if [[ "$EUID" -eq 0 ]]; then
+        "$@"
+    elif command -v sudo >/dev/null 2>&1; then
+        sudo "$@"
+    else
+        fail 'sudo is required to install packages or change the login shell.'
+    fi
+}
+
+run_as_user() {
+    if [[ "$EUID" -eq 0 && "$TARGET_USER" != 'root' ]]; then
+        runuser -u "$TARGET_USER" -- "$@"
+    else
+        "$@"
+    fi
+}
+
+backup_file() {
+    local file="$1"
+    [[ -f "$file" ]] || return 0
+
+    local backup="${file}.easy-command-backup-$(date +%Y%m%d%H%M%S)"
+    cp "$file" "$backup"
+    info "Backed up $file to $backup"
+}
+
+remove_managed_block() {
+    local zshrc="$TARGET_HOME/.zshrc"
+    [[ -f "$zshrc" ]] || return 0
+
+    local temp_file
+    temp_file="$(mktemp)"
+    awk -v begin="$BEGIN_MARKER" -v end="$END_MARKER" '
+        $0 == begin { skipping = 1; next }
+        $0 == end { skipping = 0; next }
+        !skipping { print }
+    ' "$zshrc" > "$temp_file"
+    cat "$temp_file" > "$zshrc"
+    rm -f "$temp_file"
+    chown "$TARGET_USER" "$zshrc" 2>/dev/null || true
+}
+
+install_packages() {
+    case "$(uname -s)" in
+        Darwin)
+            command -v brew >/dev/null 2>&1 || fail 'Homebrew is required on macOS: https://brew.sh'
+            brew install zsh git
+            ;;
+        Linux)
+            command -v apt-get >/dev/null 2>&1 || fail 'Only Ubuntu/Debian (apt-get) is supported on Linux.'
+            run_as_root apt-get update
+            run_as_root env DEBIAN_FRONTEND=noninteractive apt-get install -y zsh git
+            ;;
+        *) fail "Unsupported operating system: $(uname -s)" ;;
+    esac
+}
+
+install_repository() {
+    local repository="$1"
+    local destination="$2"
+    [[ -d "$destination/.git" ]] && return 0
+
+    mkdir -p "$(dirname "$destination")"
+    run_as_user git clone --depth 1 "$repository" "$destination"
+}
+
+write_zshrc_block() {
+    local zshrc="$TARGET_HOME/.zshrc"
+    local temp_file
+    temp_file="$(mktemp)"
+
+    [[ -f "$zshrc" ]] && awk -v begin="$BEGIN_MARKER" -v end="$END_MARKER" '
+        $0 == begin { skipping = 1; next }
+        $0 == end { skipping = 0; next }
+        !skipping { print }
+    ' "$zshrc" > "$temp_file"
+
+    cat >> "$temp_file" <<'EOF'
+
+# >>> easy-command zsh >>>
+# Managed by easy-command. Re-run the installer to update this block.
+export ZSH="$HOME/.easy-command/oh-my-zsh"
+ZSH_THEME="agnoster"
+plugins=(git zsh-autosuggestions zsh-syntax-highlighting)
+
+HISTFILE="$HOME/.zsh_history"
+HISTSIZE=10000
+SAVEHIST=10000
+setopt append_history share_history hist_ignore_dups
+ZSH_AUTOSUGGEST_STRATEGY=(history completion)
+ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=8'
+
+source "$ZSH/oh-my-zsh.sh"
+
+ZSH_HIGHLIGHT_STYLES[command]='fg=green'
+ZSH_HIGHLIGHT_STYLES[builtin]='fg=green'
+ZSH_HIGHLIGHT_STYLES[function]='fg=green'
+ZSH_HIGHLIGHT_STYLES[alias]='fg=green'
+ZSH_HIGHLIGHT_STYLES[unknown-token]='fg=red,bold'
+# <<< easy-command zsh <<<
+EOF
+
+    backup_file "$zshrc"
+    cat "$temp_file" > "$zshrc"
+    rm -f "$temp_file"
+    chown "$TARGET_USER" "$zshrc" 2>/dev/null || true
+}
+
+change_login_shell() {
+    "$CHANGE_LOGIN_SHELL" || return 0
+
+    local zsh_path
+    zsh_path="$(command -v zsh)"
+    grep -qx "$zsh_path" /etc/shells || fail "$zsh_path is not listed in /etc/shells."
+    run_as_root chsh -s "$zsh_path" "$TARGET_USER"
+}
+
+main() {
+    if "$UNINSTALL"; then
+        backup_file "$TARGET_HOME/.zshrc"
+        remove_managed_block
+        info 'Removed the easy-command managed .zshrc block.'
+        exit 0
+    fi
+
+    if ! "$ASSUME_YES"; then
+        read -r -p "Install easy-command for $TARGET_USER? [y/N] " answer
+        [[ "$answer" =~ ^[Yy]$ ]] || exit 0
+    fi
+
+    install_packages
+
+    local base_dir="$TARGET_HOME/.easy-command"
+    install_repository 'https://github.com/ohmyzsh/ohmyzsh.git' "$base_dir/oh-my-zsh"
+    install_repository 'https://github.com/zsh-users/zsh-autosuggestions.git' "$base_dir/oh-my-zsh/custom/plugins/zsh-autosuggestions"
+    install_repository 'https://github.com/zsh-users/zsh-syntax-highlighting.git' "$base_dir/oh-my-zsh/custom/plugins/zsh-syntax-highlighting"
+
+    write_zshrc_block
+    change_login_shell
+
+    info "Installed easy-command $VERSION for $TARGET_USER. Reconnect or run: exec zsh -l"
+}
+
+main

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "easy-command",
+  "version": "1.0.4",
+  "description": "Configure a polished Zsh terminal with one command.",
+  "license": "MIT",
+  "bin": {
+    "easy-command": "bin/easy-command"
+  },
+  "files": [
+    "bin",
+    "install.sh",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/UnionSchool/easy-command.git"
+  },
+  "bugs": {
+    "url": "https://github.com/UnionSchool/easy-command/issues"
+  },
+  "homepage": "https://github.com/UnionSchool/easy-command#readme",
+  "keywords": [
+    "zsh",
+    "oh-my-zsh",
+    "terminal",
+    "cli",
+    "installer"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}