/gitlab-checker

Command line utility that uses the gitlab API to check your repo and base funcionality.

Primary LanguageShellMIT LicenseMIT

Gitlab Check

Build Status codecov

gitlab-check command line utility that uses the gitlab API to check your repository and base funcionality.

gitlabchecker

Usage

gitlab-check -n "https://gitlab.foo-bar.com" -i 194 -t gI1l4bR4nD0m1Ok3nH3r3

Parameters

gitlab-check [ -n | -i | -t | -h ]

-n <ip|hostname>
Name of the host or IP address.

-i <number>
Project ID.
See: "Project" -> "General Settings" -> "Expand: General project settings"

-t
Personal access tokens. 
See: "User Settings" -> "Access Tokens"

-h
Prints this help.

Installation

git clone https://github.com/hyperia-sk/gitlab-checker.git && cd gitlab-checker

Open up the cloned directory and run:

Unix like OS

sudo make install

For uninstalling

sudo make uninstall

For update/reinstall

sudo make reinstall

OS X (homebrew)

@todo

Windows (cygwin)

@todo

System requirements

  • Unix like OS with a proper shell
  • Tools we use: basename ; mktemp ; tee ; tail ; seq ; awk ; tr ; printf ; curl ; wget ; jq ; git

sudo apt install git jq wget curl

Contribution

Want to contribute? Great! First, read this page.

Code reviews

All submissions, including submissions by project members, require review. We use Github pull requests for this purpose.

Some tips for good pull requests:

  • Use our code When in doubt, try to stay true to the existing code of the project.
  • Write a descriptive commit message. What problem are you solving and what are the consequences? Where and what did you test? Some good tips: here and here.
  • If your PR consists of multiple commits which are successive improvements / fixes to your first commit, consider squashing them into a single commit (git rebase -i) such that your PR is a single commit on top of the current HEAD. This make reviewing the code so much easier, and our history more readable.

Formatting

This documentation is written using standard markdown syntax. Please submit your changes using the same syntax.

Tests

make test

Licensing

MIT see LICENSE for the full license text.