Commit 9c0c875b authored by Jeroen van Baarsen's avatar Jeroen van Baarsen

Merge pull request #169 from cirosantilli/md-style

Update README Markdown style to match CONTRIBUTING
parents 59bffe6b 1fd77296
# gitlab-shell: ssh access and repository management # 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
[![CI](http://ci.gitlab.org/projects/4/status.png?ref=master)](http://ci.gitlab.org/projects/4?ref=master) [![CI](http://ci.gitlab.org/projects/4/status.png?ref=master)](http://ci.gitlab.org/projects/4?ref=master)
[![Build Status](https://travis-ci.org/gitlabhq/gitlab-shell.png?branch=master)](https://travis-ci.org/gitlabhq/gitlab-shell) [![Build Status](https://travis-ci.org/gitlabhq/gitlab-shell.png?branch=master)](https://travis-ci.org/gitlabhq/gitlab-shell)
[![Code Climate](https://codeclimate.com/github/gitlabhq/gitlab-shell.png)](https://codeclimate.com/github/gitlabhq/gitlab-shell) [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlab-shell.png)](https://codeclimate.com/github/gitlabhq/gitlab-shell)
[![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlab-shell/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlab-shell) [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlab-shell/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlab-shell)
**Requires ruby 1.9+**
__Requires ruby 1.9+__ ## Setup
### Setup
./bin/install ./bin/install
## Check
### Check
./bin/check ./bin/check
## Repos
### Repos: Add repo:
Add repo
./bin/gitlab-projects add-project gitlab/gitlab-ci.git ./bin/gitlab-projects add-project gitlab/gitlab-ci.git
Remove repo Remove repo:
./bin/gitlab-projects rm-project gitlab/gitlab-ci.git ./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 ./bin/gitlab-projects import-project randx/six.git https://github.com/randx/six.git
# Override timeout in seconds # Override timeout in seconds
./bin/gitlab-projects import-project randx/six.git https://github.com/randx/six.git 90 ./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 ./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 ./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 ./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 ./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
./bin/gitlab-projects create-tag gitlab/gitlab-ci.git v3.0.0 3-0-stable 'annotated message goes here' ./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 ./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..." ./bin/gitlab-keys add-key key-782 "ssh-rsa AAAAx321..."
Remove key Remove key:
./bin/gitlab-keys rm-key key-23 "ssh-rsa AAAAx321..." ./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 ./bin/gitlab-keys clear
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment