Bashmarks 使用与技术文档

1. 安装指南

Bashmarks 是一个允许您保存和快速跳转到常用目录的 shell 脚本，现在支持 tab 自动补全功能。以下是安装 Bashmarks 的步骤：

1. 克隆项目仓库到本地：

   git clone [e-mail]:huyng/bashmarks.git
   

2. 切换到项目目录：

   cd bashmarks
   

3. 运行 make install 命令进行安装：

   make install
   

4. 在您的 ~/.bash_profile 或 ~/.bashrc 文件中 source ~/.local/bin/bashmarks.sh：

   source ~/.local/bin/bashmarks.sh
   

确保在完成上述步骤后重启您的终端或运行 source ~/.bashrc（或对应的配置文件），以确保 Bashmarks 脚本生效。

2. 项目使用说明

Bashmarks 提供了一系列的 shell 命令来帮助您管理目录书签：

• s <bookmark_name>：保存当前目录为 "bookmark_name"
• g <bookmark_name>：跳转到与 "bookmark_name" 关联的目录
• p <bookmark_name>：打印与 "bookmark_name" 关联的目录
• d <bookmark_name>：删除书签 "bookmark_name"
• l：列出所有可用的书签

示例用法

$ cd /var/www/
$ s webfolder
$ cd /usr/local/lib/
$ s locallib
$ l
$ g web<tab>
$ g webfolder

在上面的示例中，首先进入 /var/www/ 目录并保存为书签 webfolder，然后进入 /usr/local/lib/ 目录并保存为书签 locallib。使用 l 命令列出所有书签，并通过 tab 自动补全功能快速跳转到 webfolder。

3. 项目API使用文档

Bashmarks 的 API 使用文档主要围绕其提供的 shell 命令。以下是对每个命令的详细描述：

• s <bookmark_name>：此命令会将当前工作目录的路径保存为名为 "bookmark_name" 的书签。如果该书签已存在，它会被覆盖。
• g <bookmark_name>：此命令会切换到名为 "bookmark_name" 的书签所指向的目录。
• p <bookmark_name>：此命令会打印出名为 "bookmark_name" 的书签所指向的目录路径。
• d <bookmark_name>：此命令会删除名为 "bookmark_name" 的书签。
• l：此命令会列出所有已保存的书签及其对应的目录路径。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中详细说明。简要概述如下：

• 使用 git 克隆项目仓库。
• 切换到项目目录。
• 运行 make install 命令。
• 在 .bash_profile 或 .bashrc 文件中 source Bashmarks 脚本。

确保在终端中执行上述步骤后，Bashmarks 将可用于您的 shell 环境。