diff options
author | Ciro Santilli <ciro.santilli@gmail.com> | 2014-08-09 19:49:25 +0200 |
---|---|---|
committer | Ciro Santilli <ciro.santilli@gmail.com> | 2014-08-11 17:19:19 +0200 |
commit | 1fd77296f099e12d26930db351520a9879a121ab (patch) | |
tree | b36ab453072234d78f533939e0732803d7daab15 | |
parent | 59bffe6b1ed6ed425723cf6d98259bdee9f75f0a (diff) | |
download | gitlab-shell-1fd77296f099e12d26930db351520a9879a121ab.tar.gz |
Update README Markdown style to match CONTRIBUTING
-rw-r--r-- | README.md | 52 |
1 files changed, 23 insertions, 29 deletions
@@ -1,85 +1,79 @@ # gitlab-shell: ssh access and repository management -GitLab Shell is an application that allows you to execute git commands and provide ssh access to git repositories. It is not a unix shell nor a replacement for Bash or Zsh. +GitLab Shell is an application that allows you to execute git commands +and provide ssh access to git repositories. +It is not a Unix shell nor a replacement for Bash or Zsh. -#### Code status +## Code status [](http://ci.gitlab.org/projects/4?ref=master) [](https://travis-ci.org/gitlabhq/gitlab-shell) [](https://codeclimate.com/github/gitlabhq/gitlab-shell) [](https://coveralls.io/r/gitlabhq/gitlab-shell) +**Requires ruby 1.9+** -__Requires ruby 1.9+__ - - -### Setup +## Setup ./bin/install - -### Check +## Check ./bin/check +## Repos -### Repos: - - -Add repo +Add repo: ./bin/gitlab-projects add-project gitlab/gitlab-ci.git -Remove repo +Remove repo: ./bin/gitlab-projects rm-project gitlab/gitlab-ci.git -Import repo +Import repo: - # Default timeout is 2 minutes + # Default timeout is 2 minutes ./bin/gitlab-projects import-project randx/six.git https://github.com/randx/six.git - + # Override timeout in seconds ./bin/gitlab-projects import-project randx/six.git https://github.com/randx/six.git 90 -Fork repo +Fork repo: ./bin/gitlab-projects fork-project gitlab/gitlab-ci.git randx -Update HEAD +Update HEAD: ./bin/gitlab-projects update-head gitlab/gitlab-ci.git 3-2-stable -Create branch +Create branch: ./bin/gitlab-projects create-branch gitlab/gitlab-ci.git 3-2-stable master -Remove branch +Remove branch: ./bin/gitlab-projects rm-branch gitlab/gitlab-ci.git 3-0-stable -Create tag (lightweight & annotated) +Create tag (lightweight & annotated): ./bin/gitlab-projects create-tag gitlab/gitlab-ci.git v3.0.0 3-0-stable ./bin/gitlab-projects create-tag gitlab/gitlab-ci.git v3.0.0 3-0-stable 'annotated message goes here' -Remove tag +Remove tag: ./bin/gitlab-projects rm-tag gitlab/gitlab-ci.git v3.0.0 +## Keys -### Keys: - - -Add key +Add key: ./bin/gitlab-keys add-key key-782 "ssh-rsa AAAAx321..." -Remove key +Remove key: ./bin/gitlab-keys rm-key key-23 "ssh-rsa AAAAx321..." -Remove all keys from authorized_keys file +Remove all keys from authorized_keys file: ./bin/gitlab-keys clear - |