Coral 项目技术文档

本文档旨在帮助用户安装和使用Coral项目，并提供相关的API使用指南。

1. 安装指南

Coral的安装非常简单，只需按照以下步骤操作：

git clone git://github.com/mislav/coral.git ~/.coral

# 显示如何编辑shell配置的说明：
~/.coral/bin/coral init

# 重新加载新的shell配置后：
coral doctor

2. 项目的使用说明

Coral提供了一系列的shell命令来帮助用户更高效地处理开源项目、Ruby应用和GitHub等。

组织GitHub仓库的克隆

如果您经常阅读代码或为多个开源项目贡献，可能会厌倦为每个项目选择克隆目标。

Coral可以帮助您克隆仓库并保持其内部目录结构：

coral clone bootstrap             # 将搜索GitHub并选择第一个结果
coral clone twitter/bootstrap     # 如果您想明确指定
coral path bootstrap              # 显示Bootstrap在本地的路径

coral cd bootstrap                # 切换到Bootstrap的项目目录
git tag | coral sort-versions     # 显示可用的版本

coral checkout bootstrap v2.2.0   # 为Bootstrap v2.2.0创建一个新的工作副本
coral cd bootstrap@v2.2.0         # 切换到新的工作副本

coral list bootstrap              # 列出Bootstrap的所有工作副本

处理RubyGems和 Bundler

Coral的所有gem命令都是Bundler感知的，即当您给它们一个gem的名字时，它们首先在当前bundle中搜索，然后在全球安装的gems中搜索。这有助于您检查项目当前使用的gem版本。

coral gem-dir activesupport       # 打印gem的根目录
coral gem-open activesupport      # 在编辑器中打开gem的源代码
coral gem-browse sinatra          # 在浏览器中打开Sinatra的主页
coral gem-browse-project sinatra  # 在GitHub上打开Sinatra的项目页面

coral bundle-ack -w redirect_to   # 在bundle中的所有gems中搜索

渲染文档文件为HTML

# 以GitHub.com的方式渲染任何标记：
coral github-markup path/to/README.md >> readme.html

# `github-markup` 输出 + 样式和语法高亮；管道传输到浏览器
coral render-markup path/to/README.md | bcat

在编辑器中打开源代码

方便的快捷方式，用于在您喜欢的文本编辑器中打开项目目录。gem-open命令还有一个很好的特性，可以为您预加载README文件（如果存在）：

coral gem-open activesupport      # 在编辑器中打开gem的源代码及README
coral open-dir path/to/project    # 在$EDITOR中打开一个项目

您应该将您的shell配置如下：

• Vim:

    EDITOR=vim
    GEM_EDITOR=mvim   # 或者在Linux上使用 "gvim"
  

• Sublime Text 2:

    EDITOR='subl -w'
    GEM_EDITOR=subl
  

• TextMate:

    EDITOR='mate -w'
    GEM_EDITOR=mate
  

杂项Unix工具

coral sort-versions               # 在STDIN上排序版本号
coral fetch-url <url>             # 获取URL并将结果缓存24小时
coral parse-json                  # 解析JSON并以平面、基于行的格式输出

3. 项目API使用文档

Coral项目目前主要以shell命令的形式提供功能，没有提供传统的API接口。用户应参考上述使用说明中的命令行调用方式来进行操作。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细描述，请参照执行即可。