Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roaldnefs/tanuki

A tool for performing actions on GitLab repos or a single repo.
https://github.com/roaldnefs/tanuki

gitlab gitlab-api gitlab-ce

Last synced: about 1 month ago
JSON representation

A tool for performing actions on GitLab repos or a single repo.

Awesome Lists containing this project

README

        

tanuki

[![Travis CI](https://img.shields.io/travis/roaldnefs/tanuki.svg?style=for-the-badge)](https://travis-ci.org/roaldnefs/tanuki)
[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=for-the-badge)](https://godoc.org/github.com/roaldnefs/tanuki)
[![Github All Releases](https://img.shields.io/github/downloads/roaldnefs/tanuki/total.svg?style=for-the-badge)](https://github.com/roaldnefs/tanuki/releases)

Named after the raccoon dog logo of GitLab. A tool for performing actions on GitLab repos or a single repo.

* [Installation](README.md#installation)
* [Binaries](README.md#binaries)
* [Via Go](README.md#via-go)
* [Usage](README.md#usage)
* [Audit](README.md#audit)
* [Configuration](README.md#configuration)

## Installation

### Binaries

For installation instructions from binaries please visit the [Releases Page](https://github.com/roaldnefs/tanuki/releases).

### Via Go

```console
$ go get github.com/roaldnefs/tanuki
```

## Usage

```console
$ tanuki -h
A tool for performing actions on GitLab repos or a single repo.

Usage:
tanuki [command]

Available Commands:
audit Audit members, branches, hooks, deploy keys etc.
help Help about any command
version Print the version number of Tanuki

Flags:
--config string config file (default is $HOME/.tanuki.yaml)
-d, --debug enable debug logging (default false)
--dry-run do not change settings just print the changes that would occur (default false)
-h, --help help for tanuki
-t, --token string GitLab API token
-u, --url string GitLab URL (default "https://gitlab.com/")

Use "tanuki [command] --help" for more information about a command.
```

### Audit

Audit members, branches, hooks, deploy keys etc.

```console
$ tanuki audit audit --token token --url https://gitlab.com/ --repository roaldnefs/tanuki
roaldnefs / tanuki ->
Members (1):
Owner (1):
roaldnefs
Maintainer (0):

Developer (0):

Reporter (0):

Guest (0):

Deloy Keys (2):
Read-only (1):
user@server
Read-write (1):
user@server

Visibility: private
Merge Method: merge

--
```

## Configuration

Tanuki will be easier to use if you provide a simple configuration file which help you eliminate providing a bunch of repeated information in flags over and over.

An example `~/.tanuki.yaml` file:

```yaml
token: TOKEN
url: https://gitlab.example.com/
```