Skip to content

binave/xcmd

BranchesTags

Repository files navigation

eXternal Command

command-line wrapper for batch and shell.

一些常用的 batch 和 shell 方法合集。
xlib 将仅使用第一方工具，开箱即用。包括子命令在内实用命令达到数十个。
x3rd 对一些第三方命令行工具进行了封装。

Licensing

xcmd is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

将脚本文件放入环境变量后，通过 -h 或者 --help 参数获得使用帮助。
shell 脚本需要注意赋予可执行权限，注意下载后确认源码中行尾使用 LF换行，否则脚本会无法执行。
Windows 脚本支持从 UNC（SMB） 路径启动，方便作为服务来使用，注意下载后确认源码行尾使用 CRLF换行，否则脚本会无法执行，同时避免在脚本中使用非 ANSI 字符。

Q: 如何唤醒同一个网段的电脑（Wake on lan）。

A:

  1. 下载 xlib 或 xlib.cmd 到本地计算机执行

    # aa:bb:cc:dd:ee:ff 为目标网卡的 MAC 地址。
xlib wol aa:bb:cc:dd:ee:ff

Q: 如何在不支持 TPM 的计算机上，快速使用 Windows 系统的 BitLocker 加密所有磁盘。

A:

  1. 准备一个 FAT32 格式的 USB 存储设备，连接到计算机，用于存放开机密钥。

  2. 下载 xlib.cmd 到本地计算机，执行

    xlib vol --encrypts-all

    2.1. 或者从 smb 服务器（如 192.168.1.1）的 UNC 路径执行

    \\192.168.1.1\xcmd\xlib vol --encrypts-all

  3. 如果需要隐藏磁盘上的加密标识和消除右键菜单上的 BitLocker 菜单，执行

    xlib vol --hide-bitlocker

  4. 更详细的操作方法（包括禁止外接磁盘写操作，指定 USB 存储设备盘符等），可以使用

    xlib vol --help

    进行查询。

Q: 如何在 macOS 系统上截获 AppStore 原版 pkg 安装包。

A:

  1. 下载 xlib 到本地计算机执行

    xlib pkg -g 5

  2. 打开 AppStore 下载（而不是更新）任意若干个应用。

  3. 在 Download 文件夹中等待应用 pkg 包的出现。

Q: 如何批量搜索同一网络中的 IP 不固定的计算机，并用固定的名称访问。而不是登录每个电脑去看 IP 地址。

A:

  1. 收集需要搜寻电脑网卡的 MAC 地址。

  2. 在用户目录 %USERPROFILE% 或 $HOME 下建立 .host.ini 空文件，并按照下列示例进行编辑

    [hosts]
; 单个 mac 地址，匹配不到会忽略。
gl.inet=00:11:00:00:00:00

; 从左开始匹配，都匹配不到会设置为最后的 |127.0.0.1
syno-15=00-11-00-00-11-00|11:00:00:00:00:11|00-11-00-00-00-11|127.0.0.1 ;nat hosts

; 直接设置为固定的 IPv4
binave.com=127.0.0.1

[sip_setting]
; 搜寻的 IPv4 范围
range=1-120

  3. 在 Windows 系统下下载 xlib.cmd 或在 macOS 系统下下载 xlib 执行

    xlib hosts

    等待打印搜寻结果，结果会写入 hosts 文件中，所以需要管理员权限执行命令。

Q: 如何搭建一个最新版 Microsoft Office 可定制安装服务。

A:

  1. 搭建一个 smb 服务（比如 192.168.1.1），并建立目录 xcmd\

  2. 下载 xlib.cmd 并执行

    xlib odt -d \\192.168.1.1\xcmd

    以下载最新的 Microsoft Office 安装文件。

  3. 复制 xlib.cmd 到 \\192.168.1.1\xcmd。建议同时复制 %temp%\27af1be6-dd20-4cb4-b154-ebab8a7d4a7e 下的 odt.exe。

  4. 服务搭建完成，在目标计算机上执行

    \\192.168.1.1\xcmd\xlib odt -i word excel powerpoint

    安装 word excel powerpoint，其余 office 组件将被忽略。

Q: 我有 kms 服务部署在 192.168.1.1 上，如何快速激活 Windows 和 office。

A:

  1. 下载 xlib.cmd 并执行

    xlib kms -s 192.168.1.1

    激活 Windows。
    执行

    xlib kms -o 192.168.1.1

    激活 office

Q: 如何在旧版本的 Windows 之间，通过远程桌面的剪贴板，传输小文件或文件夹。

A:

  1. 在本地和远端下载 clipTransfer.vbs，或将源码复制到任意 vbs 中。
  2. 在任意一端，把文件或文件夹拖动到 vbs 脚本上。
  3. 等待提示完成。
  4. 在另一端双击 vbs 脚本即可。
  5. 视网好坏将等待不同的时间。

Q: 如何将多个 batch （批处理）函数，或者 shell 函数放入一个脚本中，通过方法名快速调用，并支持错误输出。

A:

  1. mac 和 linux 下新建 sh 文件，并写入以下内容（注意赋予可执行权限）。

    #!/bin/bash

#################################################
#               Custom Functions                #
  # # # # # # # # # # # # # # # # # # # # # # #
### somefunc ##Usage: somefunc info # need modify
_pre_somefunc () {
    : # function body
    exit 1 # error info, need modify
}

  # # # # # # # # # # # # # # # # # # # # # # #
#               Custom Functions                #
#################################################

# Print Error info
_func_err () {
    [[ "$4$6" == exit_${0##*/}* ]] && {
        local err=`sed -n $2p "$0"` # local err=`awk 'NR=='$2'{print}' "$0"`;
        printf "\033[31mError:${err##*#} \033[33m($0:$2)\033[0m\n" >&2; # Print line text after '#'
        exit $(($5 % 256))
    };

    [ "$4" == "return" ] && exit $(($5 % 256)); # WARRAN: 0 <= $? <= 255, return 256: $? = 0
    [ $1 == 127 ] && { # Get script line
        printf "\033[31mError: No function found \033[0m\n" >&2; # No function found
        exit 1
    };
    exit 0
}

_func_annotation () { # Show function info
    local i j k OLDIFS IFS=$IFS\({;
    OLDIFS=$IFS; # Cache IFS
    [ "$1" ] && { # show select
        while read i j; do
            [ "$i" == "###" ] && { # Make array splite with
                IFS=#;
                k=($j);
                IFS=$OLDIFS
            };
            [ "$k" -a "$i" == "_${0##*/}_$1" ] && { # At target func name
                for i in ${!k[@]}; do
                    printf "${k[$i]}\n"; # Print all annotation
                done;
                return 0
            };
            [[ "$i" == _${0##*/}* ]] && [ "$j" == ")" ] && unset k; # Reset var
        done < "$0"; # Scan this script
        return 1
    } || {
        while read i j; do # show all
            [ "$i" == "###" ] && k=${j%%#*}; # Cache intro
            [ "${i%_*}" == "_${0##*/}" -a "$j" == ")" ] && { # At func name
                printf "%-15s$k\n" ${i##*_}; # Left aligned at 15 char
                unset k # Clear var
            };
        done < "$0"; # Scan this script
    }
}
# Cache exit
trap '_func_err $? $LINENO $BASH_LINENO $BASH_COMMAND ${FUNCNAME[@]}' EXIT

[[ ! "$1" || "$1" == "-h" || "$1" == "--help" ]] && { # Test if help
    _func_annotation | sort;
    exit 0
} || [[ "$2" == "-h" || "$2" == "--help" ]] && {

    _func_annotation $1 || printf "\033[31mError: No function found \033[0m\n" >&2; # Test if help
    exit $?
};

_pre_"$@" # main $*, "$*", $@ can not keep $#, only "$@" can save native structural

  2. Windows 下新建 cmd 文件，写入以下内容

    @echo off

@REM init errorlevel
set errorlevel=

@REM Init PATH
for %%a in (%~nx0) do if "%%~$path:a"=="" set path=%path%;%~dp0

if "%~2"=="-h" call :this\annotation :pre\%~1 & exit /b 0
if "%~2"=="--help" call :this\annotation :pre\%~1 & exit /b 0

2>nul call :pre\%*

if not errorlevel 0 exit /b 1

@REM Test type function
if errorlevel 1 call :this\annotation :pre\%* & goto :eof
exit /b 0

:::::::::::::::::::::::::::::::::::::::::::::::
::             Custom Functions              ::
   :: :: :: :: :: :: :: :: :: :: :: :: :: ::

::: "do some thing"
:pre\somefunc
    @REM function body
    exit /b 2 @REM error message, [`注意`] 请不要使用错误代码 `1`。
    goto :eof

@REM `:pre\` 和多个 `:sub\` 组成一个方法组，方法组之间的代码不可以交叉。
@REM 不同的方法组，可以重复使用大于 `1` 的错误代码，方法组内的错误代码不可重复。
::: "do multi things" "" "usage: %~n0 multifunc [option]" ""
:pre\multifunc
    if "%~1"=="" call :this\annotation %0 & goto :eof
    call :sub\multifunc\%*
    goto :eof

::: "    --arg      run something"
:sub\multifunc\--arg
    exit /b 11 @REM error message
    exit /b 0

   :: :: :: :: :: :: :: :: :: :: :: :: :: ::
::             Custom Functions              ::
:::::::::::::::::::::::::::::::::::::::::::::::

@REM Show function list, func info or error message, complete function name
:this\annotation
    setlocal enabledelayedexpansion & set /a _err_code=%errorlevel%
    set _annotation_more=
    set _err_msg=
    for /f "usebackq skip=20 delims=" %%a in (
        "%~f0"
    ) do for /f "usebackq tokens=1,2* delims=\	 " %%b in (
        '%%a'
    ) do (
        if /i "%%~b"==":::" (
            set _annotation=%%a
            set _annotation=!_annotation:* =!

        ) else if defined _func_eof (
            if %_err_code% gtr 1 (
                set _err_msg=%%~a
                set _un_space=!_err_msg: =!
                @REM match error message
                if "!_un_space:exit/b%_err_code%=!" neq "!_un_space!" >&2 ^
                    echo [ERROR] !_err_msg:* @REM =! ^(%~f0!_func_eof!^)&& exit /b 1

            ) else if %_err_code%==1 >&2 echo [ERROR] invalid option '%~2' ^(%~f0!_func_eof!^)&& exit /b 1
        )

        @REM match arguments, sub function
        if /i "%%~b\%%~c"==":sub\%~nx1" (
            set _func_eof=%%~a
            if defined _annotation if %_err_code%==0 call %0\more !_annotation!
            set _annotation=

        ) else if /i "%%~b"==":pre" (
            @REM match new function, clear function name
            if defined _annotation_more exit /b 0
            if defined _err_msg >&2 echo unknown error.& exit /b 1
            set _func_eof=

            @REM match target function
            if /i "%%~b\%%~c"=="%~1" (
                set _func_eof=%%~a
                if defined _annotation if %_err_code%==0 call %0\more !_annotation!
                set _annotation=

            )
            @REM init func var, for display all func, or show sort func name
            set _prefix_4_auto_complete\%%~c=!_annotation! ""

        )

    )

    if defined _annotation_more exit /b 0
    if defined _err_msg >&2 echo unknown error.& exit /b 1

    @REM Foreach func list
    call :pre\cols _col
    set /a _i=0, _col/=16
    for /f usebackq^ tokens^=1^,2^ delims^=^=^" %%a in (`
        2^>nul set _prefix_4_auto_complete\%~n1
    `) do if "%~1" neq "" (
        @REM " Sort func name expansion
        set /a _i+=1
        if !_i!==1 (
            set _cache_arg=%%~nxa
            if "%~2" neq "" (
                set _args=%*
                set _args=%%~nxa !_args:* =!
            ) else set _args=%%~nxa

        ) else if !_i!==2 (
            call :sub\txt\--all-col-left !_cache_arg! %_col%
            call :sub\txt\--all-col-left %%~nxa %_col%

        ) else if !_i! geq 2 call :sub\txt\--all-col-left %%~nxa %_col%

    ) else call :sub\str\--2col-left %%~nxa "%%~b"

    @REM Close lals
    if !_i! gtr 0 call :sub\txt\--all-col-left 0 0

    @REM Display func or call func
    endlocal & if %_i% gtr 1 (
        echo.
        >&2 echo [WARN] function sort name conflict
        exit /b 1

    ) else if %_i%==0 (
        if "%~1" neq "" >&2 echo [ERROR] No function found& exit /b 1

    ) else if %_i%==1 2>nul call :pre\%_args% || call %0 :pre\%_args%
    goto :eof

:this\annotation\more
    echo.%~1
    shift /1
    if "%~1" neq "" goto %0
    if .%1==."" goto %0
    set _annotation_more=true
    exit /b 0

::: "Get cmd cols" "" "usage: pre cols [[var_name]]"
:pre\cols
    for /f "usebackq skip=4 tokens=2" %%a in (
        `mode.com con`
    ) do (
        if "%~1"=="" (
            echo %%a
        ) else set %~1=%%a
        exit /b 0
    )
    exit /b 0

:sub\txt\--all-col-left
    if "%~1"=="" exit /b 10
    if "%~2" neq "" if 1%~2 lss 12 (if defined _acl echo. & set _acl=) & exit /b 0
    setlocal enabledelayedexpansion
    set _str=%~10123456789abcdef
    if "%_str:~31,1%" neq "" call :strModulo
    if "%~2" neq "" if 1%_acl% geq 1%~2 echo. & set /a _acl-=%~2-1
    set /a _len=0x%_str:~15,1%
    set "_spaces=                "
    >&3 set /p=%~1!_spaces:~0,%_len%!<nul
    set /a _acl+=1
    if "%~2" neq "" if 1%_acl% geq 1%~2 echo. & set _acl=
    endlocal & set _acl=%_acl%
    exit /b 0

:sub\str\--2col-left
    if "%~2"=="" exit /b 5
    setlocal enabledelayedexpansion
    set _str=%~10123456789abcdef
    if "%_str:~31,1%" neq "" call :strModulo
    set /a _len=0x%_str:~15,1%
    set "_spaces=                "
    echo %~1!_spaces:~0,%_len%!%~2
    endlocal
    exit /b 0

:strModulo
    set /a _acl+=1
    set _str=%_str:~15%
    if "%_str:~31,1%"=="" exit /b 0
    goto %0

关于 xlib.cmd 的补充说明

  1. Support for /f command. 支持在 for /f 中使用，进行判断操作时需要使用 call 命令。

  2. Support sort function name. 函数支持简名，会从左逐个字符进行命令匹配，直到匹配唯一的命>令。 如 call xlib addpath ， a 是全局唯一，可用 call xlib a >来代替。 注意：简化命令会增加执行时间，请在其他脚本中调用时使用>全名。

  3. 支持简单的多进程控制。（hosts 函数）

  4. 包含“虚拟磁盘控制”，“wim 文件控制”，“字符喘操作”，“hash 计算”等功能

  5. 使用 xlib vbs 命令会调用 xlib.vbs 脚本中的方法。进行诸如下载、转码一类的操作。

关于 xlib 、 bash.xlib 的说明

  1. 包含 shell 实现的复杂数据结构。如“字典”、“队列”等

  2. 区分部分函数 macOS 和 linux 版本。

About

command-line wrapper for batch and shell

Topics

shell map hash batch cmd batch-script bash-script

Resources

Readme

License

Apache-2.0 license
Activity

Stars

12 stars

Watchers

2 watching

Forks

4 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages