#shell #script #extension #organize #configuration #module

bin+lib terminal-magic

用于组织 shell 扩展和脚本的软件包

20 个版本

0.5.6 2023年1月9日
0.5.5 2022年7月14日
0.5.4 2022年6月28日
0.5.1 2022年3月16日
0.2.4 2020年6月15日

13#organize

每月下载量 35 次

Apache-2.0

57KB
1.5K SLoC

terminal-magic-cli

组织脚本和 shell 扩展。

安装

我们使用 cargo 来管理二进制文件。因此,请安装 rustup,然后继续。

使用 cargo install terminal-magic 来安装二进制文件,或者从仓库内部使用 cargo buildcargo install --path . 来自行构建。

用法

首次使用

您需要使用包含模块的 git 仓库初始化 terminal-magic。为此,请按照以下步骤操作

  • terminal-magic --clone <git_repo_url_with_user_name> [--ssh_key <key>](如果在克隆过程中出现问题,您可能需要删除 ~/.terminal-magic/git_modules 并再次尝试。)

  • 终端-magic list

之后,为了加载 terminal-magic 命令,您需要在 ~/.zshrc 中添加一个 source ~/.terminal-magic/env 语句。

配置

所有配置(例如 git_repo 路径和 ssh_key)都保存在 ~/.terminal-magic/global_config.toml 文件中。您可以根据需要调整属性,因为配置在每次运行 CLI 时都会被读取。

git 仓库克隆的默认路径是 ~/.terminal-magic/git_modules

列出模块

要查看所有可用的模块,请使用不带参数的 list 命令 terminal-magic list。这将尝试更新 git 仓库。目前只能自动执行快进更新。

要显示模块的帮助页面,请使用终端-magic 列表 zsh/测试。这将会显示一些元数据,包括帮助字符串、使用的依赖和定义的占位符。

安装模块

要安装模块,可以使用install命令。命令行界面仅使用相对于仓库根目录的路径来查找“模块”。

终端-magic install zsh/测试

如果脚本中定义了任何占位符,命令行界面将请求输入。如果存在数组占位符,命令行界面将添加第一个元素,然后询问您是否要继续添加条目。

原始配置文件、脚本和数据放置在~/.terminal-magic/zsh/test文件夹中(遵循仓库中的相同路径结构)。

更新模块

目前,如果占位符没有更改,只有通过命令行界面才能更新。使用update命令来更新模块cargo update zsh/test。脚本将显示配置和展开脚本的差异,您需要确认。

更新命令还可以用于向数组占位符添加新元素。尽管如此,任何更高级的更新都应在~/.terminal-magic下相应文件夹的data.toml中执行。这也是手动执行更新的地方。

依赖项

~20–34MB
~564K SLoC