Make Bash Great Again!
模块化管理命令、补全脚本、dotfile 配置的框架，适合 bash 用户。
- 链接：集中管理一系列配置文件。基于 YAML 文件，使用
one link和one unlink命令来管理软链接。 - 模块：通过模块管理 shell 脚本、补语、别名、命令、子命令。支持自定义模块。
- 仓库：通过 repo 轻松分享和重用可执行文件、子命令、配置和模块。支持自定义 repo 和多个 repo。
- 子命令：可以在一个作用域下管理自己的命令。如
a <cmd>来调用命令，避免在PATH中重复命令。请阅读 ONE_SUB Commands。 - 可配置的 one.bash：请阅读 ONE_CONF。
- 支持 bash-it：使用 one-bash-it 即可。你可以使用
one命令来管理 bash-it 的 aliases/completions/plugins。
- ✅ iTerm2
- ✅ Terminal.app
- ✅ MacOS 13 及以上版本 (Intel/ARM 架构)
- ✅ Linux/Unix 系统
- 🚫 Windows 系统
- 🚫 Zsh。本项目针对 Bash 用户开发. Zsh 用户请使用 Oh My Zsh。
详见 releases。 版本命名遵守 SemVer 2.0.0。
- sub。由 basecamp 创建的一个用来组织管理 shell 程序的框架。但已不再维护。
- bash-it。一个社区驱动的 Bash 框架。
详见 /~https://github.com/topics/one-bash
( 你可以在你的 Github 项目里添加 one-bash topic，以便分享。 )
# 设置 one.bash 的安装路径
ONE_DIR=~/.one.bash
git clone --depth 1 /~https://github.com/one-bash/one.bash.git $ONE_DIR
# 注意：你需要确保 /usr/local/bin/ 在环境变量 PATH 中
sudo ln -s "$ONE_DIR/bin/one" /usr/local/bin/one
# 安装依赖
one dep install
# 把 one.bash 加入到你的 bashrc。或者你也可以手动将 `one --bashrc` 的结果写入 bashrc。
echo '' >> ~/.bashrc
one --bashrc >> ~/.bashrc# 更新 one.bash 以及相关依赖到最新版本
one upgrade
# 检查依赖状态
one dep status# Add a repo
one repo add one-bash/one.share
one repo add one-bash/bash-it
# List available plugins/completions/aliases/bins/subs
one plugin list -a
one completion list -a
one alias list -a
one bin list -a
one sub list -a
# Enable modules on demand
# one plugin enable <name>
# one completion enable <name>
# Restart your shell- 每次启用或禁用任何模块。需要重启当前 shell 才能生效。
- 如果 shell 遇到任何严重问题并无法启动，使用
one config --edit编辑你的 ONE_CONF 文件，并且设置ONE_RC=<path-to-your-rcfile>来更改 bashrc 进行救援。
创建一个 YAML 文件，路径为 $HOME/.config/one.bash/one.links.yaml。
# It is just an example. All belows are unnecessary.
- defaults:
link:
# relink: true # If true, override the target file when it existed
create: true
# ONE_SHARE_DIR is the filepath of repo /~https://github.com/one-bash/one.share
# You must enable the repo one.share before invoking "one link"
- link:
# configs
~/.tmux.conf: $ONE_SHARE_DIR/configs/tmux/tmux.conf
$XDG_CONFIG_HOME/bat/config: $ONE_SHARE_DIR/configs/bat
$XDG_CONFIG_HOME/starship.toml: $ONE_SHARE_DIR/configs/starship.toml调用 one link 来创建软链接。
one 命令用来管理 one.bash 仓库和模块、配置以及依赖。
# 调用 `one` 会显示用法。
$ one
Usage:
one help [<CMD>] Show the usage of one command
one [<CMD>] [-h|--help] Show the usage of one command
one help-sub [<SUB_CMD>] Show the usage of ONE_SUB command
one r
one repo Manage one.bash repos
one a
one alias Manage aliases in ONE_REPO/alias/
one b
one bin Manage executable files in ONE_REPO/bin/
one c
one completion Manage completions in ONE_REPO/completion/
one p
one plugin Manage plugins in ONE_REPO/plugin/
one enabled Manage enabled modules (alias/completion/plugin)
one disable-all Disable all modules (alias/completion/plugin)
one backup Output backup scripts for current enabled modules
one config Manage user's ONE_CONF
one debug Toggle debug mode on one.bash
one dep Manage one.bash deps
one link Create symlink files based on LINKS_CONF file
one unlink remove all symbol links based on LINKS_CONF file
one upgrade Upgrade one.bash and its dependencies to latest version
one log Tail the logs of one.bash
one search Search alias/bin/completion/plugin of each enabled repo.
one sub [<SUB_CMD>] Run ONE_SUB command
one status Print one.bash status
one version Print current version of one.bash
one --bashrc Print one.bash entry codes for bashrc
Desc: A modular framework that manages commands, completions, dotfiles for bash users.
Source Code: /~https://github.com/one-bash/one.bash
Arguments:
<CMD> The one command
<SUB_CMD> The ONE_SUB command欢迎提供任何建议或者意见。
在创建新的 Issue/Discussion/PR，以及发表评论之前，请先阅读贡献指南。
Copyright 2022-2024 ADoyle (adoyle.h@gmail.com). Some Rights Reserved. The project is licensed under the Apache License Version 2.0.
Read the LICENSE file for the specific language governing permissions and limitations under the License.
Read the NOTICE file distributed with this work for additional information regarding copyright ownership.
- lobash: 帮助 Bash 脚本开发的现代化、安全、强大的工具库。
- 其他我创建的 shell 项目