jfh-gitlab-cli

Jfh::Gitlab::Cli

This gem provides an interface to Gitlab for the command line.

For this, a .env file must be created.This file is read in the following directories in order.The following file can overwrite values of the previous file.

1. /etc/jfh-gitlab-cli.env: system-wide configuration
2. ~/.jfh-gitlab-cli.env: user related configuration
3. $ (PWD)/.env: Directory related configuration.

Example of .env file

GITLAB_API_ENDPOINT=https://gitlab.com/api/v4
GITLAB_API_PRIVATE_TOKEN=[your rubygems API key]
PAGINATE_PER_PAGE=15

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add jfh-gitlab-cli

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install jfh-gitlab-cli

Usage

$ gitlab-cli --help
Usage: gitlab-cli [options]
    -l, --list-projects              List all Gitlab projects owned by user
    -v, --version                    Display the application version string
    -h, --help                       Show this message

List all projects owned by me

$ gitlab-cli --list-projects

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release:push, which will push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/jfheinrich-eu/gitlab-cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Gitlab::Cli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.