Shelr 项目技术文档

1. 安装指南

从 gem 安装

首先，确保您的系统中已安装了 Ruby 和 RubyGems。然后，使用以下命令安装 Shelr：

[sudo] gem install shelr

如果您使用的是 Ubuntu 旧版本或 Debian 旧版本，您可能需要在 .bashrc 或 .zshrc 文件中添加以下内容：

export PATH=/var/lib/gems/1.8/bin:$PATH

从软件包安装

• Ubuntu 用户可以从 PPA 安装。
• Arch Linux 用户可以使用 PKGBUILD 进行安装。
• Gentoo Linux 用户可以从 EBUILD 安装。
• Debian 用户可以尝试从 deb 包安装（需要导师）。

2. 项目使用说明

查看他人的终端录制

要查看他人的终端录制，使用以下命令：

shelr play http://shelr.tv/records/4f4ca2a43cd1090001000002.json

您也可以在网页上在线查看，访问 http://shelr.tv/。

录制您的终端

使用以下命令开始录制：

shelr record

录制开始后，您可以执行任何您想要录制的内容。要结束录制，输入 'exit' 或按下 Ctrl+D。

发布您的录制

当您有录制在本地机器上时，可以使用以下命令查看所有录制：

shelr list

选择一个录制，然后使用以下命令发布：

shelr push <ID>

如果您想要发布最近的录制，可以使用以下别名：

shelr push last

如果想要发布私有录制，可以添加 --private 选项：

shelr push last --private

这样的录制将可通过带访问键的私密 URL 访问。

3. 项目API使用文档

本项目的详细 API 文档尚未提供。请参考项目源代码和 GitHub 上的项目 Wiki 获取更多信息。

4. 项目安装方式

请参考上述“安装指南”部分，了解如何从 gem 或软件包安装 Shelr 项目。