码云（Gitee.com）帮助文档

采用传统的集中式版本控制系统（如 SVN ）的开源项目，这两个群体的用户体验都不是太好。如图1-1所示，项目的贡献者（非核心成员）很不“高兴”，因为他们即便有修改源代码的能力和渴望，也不能直接向版本库提交，要想成为提交者需要一个很长的建立信任的过程。然而即便是核心开发团队的成员，体验也不是太好，因为凡是涉及到版本库的操作（检入、检出、查看日志等）都需要在联网的状态下进行，网络带宽对用户体验影响相当大。

![cvcs-model](https://static.oschina.net/uploads/img/201705/18181722_ePPY.jpg "cvcs-model")
图1-1：使用集中式版本控制系统

Git 等分布式版本控制系统的出现，彻底颠覆了原有代码管理的组织模式。使用 Git，不再依赖唯一的、集中式的版本库，而是每个开发者本地都拥有一份完整的版本库。Git 并不排斥集中式的使用模式，但更倾向于将集中式版本库称为共享版本库。核心开发团队的成员和贡献者（非核心成员）都可以从共享版本库克隆一份本地版本库，但只有核心团队成员才可以将自己本地版本库的提交推送到共享版本库上。如图1-2所示。

![dvcs-model](https://static.oschina.net/uploads/img/201705/18181743_LKNF.jpg "dvcs-model")
图1-2：使用分布式版本控制系统

使用 Git 做版本控制（如图1-2所示），核心开发团队非常“高兴”，因为他们和共享版本库之间不必一直保持连接状态，诸如查看日志、提交、创建分支等几乎全部操作都（脱离网络）在本地的版本库中完成。项目贡献者（非核心成员）也不再那么沮丧，因为版本库人人皆可更改（当然是对本地版本库而言）。稍微让贡献者感到困难的就是如何将自己对项目的改进被核心开发团队所了解并接纳。Git 提供了多种途径，一个方法是先用 git format-patch 命令将本地提交转换为补丁文件或补丁文件序列，再通过邮件发送给核心开发团队。另外一个办法就是搭建一个自己专有的共享版本库，通过邮件创建一个拉拽请求（Pull Request），让核心团队的开发者到自己的版本库来抓取（Pull）。

![git@osc-model](https://static.oschina.net/uploads/img/201705/18181806_8HN7.jpg "git@osc-model")
图1-3：码云的协同模式

使用码云，无论是项目的核心开发团队，还是普通的项目贡献者都工作得非常“愉快”。创建项目变得非常轻松，创建者只需在码云上点击一下鼠标即可创建一个新版本库，通过简单的 Web 操作即可完成项目授权进而组建项目核心团队。在码云中，非核心团队成员参与项目也很容易。先找到自己希望参与的项目，然后只需在 Web 上点击一下鼠标即可在自己的托管空间下创建一个派生（fork）的项目，并对派生项目的版本库具有读写的完全权限，就好像这个项目原本就是由自己创立的那样。当贡献者完成开发并向自己派生的版本库推送后，可以通过码云的 Web 界面向项目的核心开发团队发送一个 Pull Request，请求审核。项目的核心团队收到 Pull Request 后审核代码，审核通过后可以直接通过 Web 界面执行合并操作接纳贡献者的提交。

1.2、码云亮点

1.3、探索码云

1.4、码云平台IDEA系列的插件使用

#1. 插件安装

**注意：码云 IDEA 插件已由　`gitosc` 更名为 `gitee`。**
**新版插件 gitee 菜单已经和 git 菜单合并**

## 方法一

1. 启动 idea
2. 选择 `Configure` - `Plugins`
3. 选择 `Browse repositories...`
4. 搜索 `gitee`，安装插件
5. 重启 idea 即可

![输入图片说明](https://static.oschina.net/uploads/img/201712/01141617_wXCn.gif "在这里输入图片标题")

## 方法二

1. 选择 `File` - `Settings`
2. 选择 `Plugins`
3. 选择 `Browse repositories...`
4. 搜索 `gitee`，安装插件
5. 重启 idea 即可

![输入图片说明](https://static.oschina.net/uploads/img/201712/01141922_Njrt.gif "在这里输入图片标题")

## 方法三

插件地址为：https://plugins.jetbrains.com/plugin/8383-gitee　直接下载，手动安装。

#2. 登陆并拉取项目

## 方法一

**1. 启动 idea，选择 `Check out from Version Control` - `码云`**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02120258_WPKq.png "在这里输入图片标题")

最新版本发生了变更，gitee 选项和 git 已经合并：

![输入图片说明](https://static.oschina.net/uploads/img/201806/26175436_HJry.png "在这里输入图片标题")

**2. 输入用户名和密码，登陆**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02120306_MS8H.png "在这里输入图片标题")

**3. 点击选框中的向下箭头，会显示当前用户在码云上的所有项目**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02120321_H6TO.png "在这里输入图片标题")

**4. 可选择任意项目进行 clone**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02120334_8SUv.png "在这里输入图片标题")

## 方法二

### 登陆

**1. 选择 `File` - `settings`**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02123545_hTwI.png "在这里输入图片标题")

**2. 选择 Version Control - 码云**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02122846_XuM9.png "在这里输入图片标题")

如果配置了公钥，可选择 ssh 方式拉取项目。

Test 按钮可测试用户名和密码是否正确。

### 拉取项目代码

**1. 选择 `VCS` - `Checkout from Version Control` - `码云`**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02123042_mnaF.png "在这里输入图片标题")

最新版 gitee 选项已经和 git 合并：

![输入图片说明](https://static.oschina.net/uploads/img/201806/26175937_Ooer.png "在这里输入图片标题")

![输入图片说明](https://static.oschina.net/uploads/img/201806/26180112_a0yC.png "在这里输入图片标题")

**2. 其他步骤同上**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02123754_WLFj.png "在这里输入图片标题")

#3. push 代码

**1. 添加文件**

右键点击需要添加的文件、文件夹

![输入图片说明](https://static.oschina.net/uploads/img/201606/02125128_1yZy.png "在这里输入图片标题")

**2. 选择commit**

右键点击文件、文件夹

![输入图片说明](https://static.oschina.net/uploads/img/201606/02125200_Mylj.png "在这里输入图片标题")

**3. 填写 commit 信息**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02125215_mCBO.png "在这里输入图片标题")

**4. 选择 push**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02125233_YqtF.png "在这里输入图片标题")

**5. 将代码 push 到线上**

![输入图片说明](https://static.oschina.net/uploads/img/201606/02125248_3yo9.png "在这里输入图片标题")

#4. 托管本地项目到码云

本地项目可以直接托管到码云，不需要在 web 上创建项目。

**1. 选择 `VCS` - `Import into Version Control` - `托管项目到码云`**

![将本地项目托管到码云](https://static.oschina.net/uploads/img/201606/02121544_480H.png "在这里输入图片标题")

**2. 填写项目信息，可选择公有或私有**

![将本地项目托管到码云](https://static.oschina.net/uploads/img/201606/02121603_Od6p.png "在这里输入图片标题")

** 3. 选择文件，填写 commit 信息。点击`OK`即可**

![将本地项目托管到码云](https://static.oschina.net/uploads/img/201606/02121631_xmdK.png "在这里输入图片标题")

#5. Tasks 关联码云 Issue

通过插件，可将 IDEA Tasks 与码云 Issue 进行关联。

**Tasks 关联仓库的步骤如下**

1. 选择 `Tools` -> `Tasks && Contexts` -> `Configure Servers...` 
2. 点击 `+` 后选择 `GitOSC`，输入用户名和仓库名称，这两个名称需要与仓库 url 中的名称一致。
3. 点击`Create API Token`，输入邮箱和密码，点击 `Login`，此时会生成 Token。
4. 最后确定即可。

![输入图片说明](https://static.oschina.net/uploads/img/201711/24153109_HM6o.gif "在这里输入图片标题")

**打开 Tasks 步骤如下**

1. 选择 `Tools` -> `Tasks && Contexts` -> `Open Task...` 
1. 列表中会显示项目的 Issue，双击。
1. 设置仓库分支等，最后确定即可。

![输入图片说明](https://static.oschina.net/uploads/img/201711/24153121_DwTZ.gif "在这里输入图片标题")

**操作 Issue**
1. `Open Task...` Task 与 Issue 建立关联。
1. `Close Active Task` 可以更新 Issue 状态。
1. `Show '***' Description` 可显示 Issue 的描述信息。
1. `Open '***' In Browser` 可在浏览器中打开 Issue 页面。
![输入图片说明](https://static.oschina.net/uploads/img/201711/24153134_BaRU.png "在这里输入图片标题")

#6. 创建代码片段

打开源码文件，在文件窗口点击右键，选择`创建代码片段...`即可。

![输入图片说明](https://static.oschina.net/uploads/img/201711/24155948_eotH.png "在这里输入图片标题")

1.5、常用工具及插件教程

1.6、码云使用容量说明

2、创建码云账号

2.1、创建码云账号

注册码云账号，只要点击导航条中的“注册”，或者点击首页中那个大大的“加入码云”按钮，即可进入注册页面。

收费吗？目前除企业版外均为免费。开源软件托管是码云的基础，对于开源项目的版本库（无论是公有版本库，还是私有版本库）的托管，码云都是免费的。在码云首页中，就有针对于个人用户的免费托管方案，如图2-1所示。

![免费方案](https://static.oschina.net/uploads/img/201704/18155757_fiOb.jpg "免费方案")
图2-1：针对个人用户的免费方案

进入码云的注册界面，依次填入各项，需注意的是：邮箱最好填写国内的邮箱，以免因为众所周知的原因无法接收激活邮件，**个性地址一经选定,无法修改，请慎重填写。**

![注册界面](https://static.oschina.net/uploads/img/201806/27181105_kWqQ.png "在这里输入图片标题")
图2-2：注册界面

我们会向您的邮箱发送一份激活邮件，请点击其中的链接激活账号，账号激活后，注册流程就算完成了。注册完毕即以新注册的账号登录，登录后即进入用户的控制面板页面。如果图2-3所示。

![控制面板](https://static.oschina.net/uploads/img/201704/18172802_RGrN.jpg "控制面板")
图2-3：登录后的码云首页

控制面板页面是用户最重要的页面，因为在这个页面中不仅可以看到组织成员的动态，还可以看到自己的项目信息，代码片段，PR，Issues，以及加入的企业信息，非常方便。

在页面右上方显示当前登录用户的名称和头像。图2-3中显示登录用户为 “不要404”。在页面右上方还有两个图标，从左至右分别是：通知和创建。点击头像图标进入【修改资料】对账号进行进一步设置，如图2-4所示。

![账户设置](https://static.oschina.net/uploads/img/201704/18190232_7R3K.jpg "账户设置")
图2-4：账户设置页

点击菜单中的【修改账户】，可以更改私人令牌、更换登陆密码、以及修改注册邮箱，如图2-5所示。

![修改账户](https://static.oschina.net/uploads/img/201704/18181420_ix0Y.jpg "修改账户")
图2-5：账户管理

其中私人令牌是和用户密码相关的密钥，当用户密码更改时私人令牌也随之更改。码云的某些应用会使用私人令牌进行身份认证，从而避免直接使用用户密码造成泄露的风险。私人令牌若泄露的危害要远远小于密码泄露，这因为私人令牌不能用于登录码云网站等，而且一旦私人令牌泄露可以很容易通过更改密码的方式更换私人令牌。

码云只允许为一个账号绑定对应一个邮件地址，以便能够将 Git 版本库中的提交正确对应到码云账户。

码云为用户提供可个性化配置的信息通知方式，如图2-6所以。

![通知方式](https://static.oschina.net/uploads/img/201806/27181317_OkNd.png "在这里输入图片标题")
图2-6：通知方式

码云为托管的 Git 版本库提供 SSH 协议支持，即用户可以用公钥认证的方式连接到码云的 SSH 服务器。点击 [生成并部署SSH key](http://git.mydoc.io/?t=154712) 了解具体实现步骤。

码云作为一个优秀程序员的聚集地，期待着你的加入！！

2.2、CSDN CODE 项目整体迁移到码云平台

3、代码托管

3.1、创建第一个项目

###1、创建项目

----------

点击右上角的![输入图片说明](https://static.oschina.net/uploads/img/201704/01152036_vITZ.jpg "在这里输入图片标题")或者![输入图片说明](https://static.oschina.net/uploads/img/201704/01152303_3MMo.jpg "在这里输入图片标题")，跳转至项目创建页面：

![输入图片说明](https://static.oschina.net/uploads/img/201704/01152603_Zb3l.jpg "在这里输入图片标题")

依次填写各项信息然后点击创建就可以了，这样我们一个项目就创建好了如果没有意外，你将看到这个页面:

![输入图片说明](https://static.oschina.net/uploads/img/201704/01152726_Wux6.jpg "在这里输入图片标题")

这样，我们在码云平台就创建好了一个项目

###2、本地初始化一个项目

----------

首先，你需要执行下面两条命令，作为 git 的基础配置，作用是告诉 git 你是谁，你输入的信息将出现在你创建的提交中。

```
git config --global user.name "你的名字或昵称"
git config --global user.email "你的邮箱"
```

然后在你的需要初始化版本库的文件夹中执行：

```
git init 
git remote add origin <你的项目地址> //注:项目地址形式为:https://gitee.com/xxx/xxx.git或者 git@gitee.com:xxx/xxx.git
```

这样就完成了一次版本你的初始化。

如果你想克隆一个项目，只需要执行：

```
git clone <项目地址>
```

###3、完成第一次提交

----------

进入你已经初始化好的或者克隆项目的目录,然后执行：

```
git pull origin master
<这里需要修改/添加文件，否则与原文件相比就没有变动>
git add .
git commit -m "第一次提交"
git push origin master
```

然后如果需要账号密码的话就输入账号密码，这样就完成了一次提交。

此时，你可以在你的个人面板、项目主页查看到你的提交记录，例如：https://gitee.com/oschina/git-osc/commit/f3dd1c5bae48fa4244e2595a39e750e5606dd9be](https://gitee.com/oschina/git-osc/commit/f3dd1c5bae48fa4244e2595a39e750e5606dd9be

按照本文档新建的项目时，在码云平台仓库上已经存在 readme 文件，故在提交时可能会存在冲突，这时您需要选择的是保留线上的文件或者舍弃线上的文件，如果您舍弃线上的文件，则在推送时选择强制推送，强制推送需要执行下面的命令：

```
git push origin master -f
```

如果您选择保留线上的 readme 文件,则需要先执行：

```
git pull origin master
```

然后才可以推送,如果发生冲突，则需要先解决冲突,关于如何处理冲突，请参阅[如何处理代码冲突](http://git.mydoc.io?v=16912&t=66902)这一小节。

3.2、公钥认证管理

开发者向码云版本库写入最常用到的协议是 SSH 协议，因为 SSH 协议使用公钥认证，可以实现无口令访问，而若使用 HTTPS 协议每次身份认证时都需要提供口令。使用 SSH 公钥认证，就涉及到公钥的管理。

### 1.如何生成ssh公钥

----------

你可以按如下命令来生成sshkey:

```sh
ssh-keygen -t rsa -C "xxxxx@xxxxx.com"

# Generating public/private rsa key pair...
# 三次回车即可生成 ssh key
```

查看你的 public key，并把他添加到码云（Gitee.com） [SSH key添加地址](http://git.oschina.net/profile/sshkeys)

```
cat ~/.ssh/id_rsa.pub
# ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6eNtGpNGwstc....
```

添加后，在终端（Terminal）中输入

```
ssh -T git@gitee.com
```

若返回

```
Welcome to Gitee.com, yourname! 
```

则证明添加成功。
* * *

### 2.怎么添加用户ssh key?

----------

1. 点击右上角的![输入图片说明](https://static.oschina.net/uploads/img/201604/14154017_ogkd.png "在这里输入图片标题")标志,进入个人中心,然后点击左侧的ssh公钥后在下图位置填写你的ssh公钥。

2. 点击确定,然后验证密码(即你的注册账号密码)就完成了ssh公钥添加。

![输入图片说明](https://static.oschina.net/uploads/img/201610/18115822_miTO.png "在这里输入图片标题")

### 3.项目的 ssh key 和用户的 ssh key 两处地方有什么不同?

----------

> 项目的 ssh key 只针对项目,且我们仅对项目提供了部署公钥,即`项目下的公钥仅能拉取项目`,这通常用于生产服务器拉取仓库的代码。
而用户的 key 则是针对用户的,用户添加了 key 就对用户名下的项目和用户参加了的项目具有权限,一般而言,用户的 key 具有推送和拉取的权限,而项目的 key 则只具有拉取权限

码云（Gitee.com）帮助文档

码云使用手册

1、什么是码云

1.1、什么是码云（Gitee.com）

1.2、码云亮点

1.3、探索码云

1.4、码云平台IDEA系列的插件使用

1.5、常用工具及插件教程

1.6、码云使用容量说明

2、创建码云账号

2.1、创建码云账号

2.2、CSDN CODE 项目整体迁移到码云平台

3、代码托管

3.1、创建第一个项目

3.2、公钥认证管理

3.3、建立主页