pagure-cli-0.2.2: README.md

# pagure-cli

[![Hackage](https://img.shields.io/hackage/v/pagure-cli.svg)](https://hackage.haskell.org/package/pagure-cli)
[![GPL-2 license](https://img.shields.io/badge/license-GPL--2-blue.svg)](LICENSE)
[![Stackage Lts](http://stackage.org/package/pagure-cli/badge/lts)](http://stackage.org/lts/package/pagure-cli)
[![Stackage Nightly](http://stackage.org/package/pagure-cli/badge/nightly)](http://stackage.org/nightly/package/pagure-cli)

A [pagure](https://docs.pagure.org/pagure/) gitforge client for querying
and listing projects (repos), users, groups, and issues.

## Usage
By default it uses the [src.fedoraproject.org](https://src.fedoraproject.org/)
Pagure server instance (aka Fedora dist-git), but this can be overriden
by the `--server` option.

### List/search for repos

`$ pagure list rac\*`

```
rpms/raceintospace
rpms/racket
```

Note by default 'orphan' owned packages are excluded.

One can also filter by owner or committer.

### List user's projects

Count projects of a user:

`$ pagure user --server pagure.io --count mattdm`

```
120
```

### List groups:

```
$ pagure groups
:
```

### List group packages
`$ pagure group budgie-sig`

```
rpms/libxfce4windowing
rpms/sassc
rpms/wlrctl
```

`$ pagure group -c rust-sig`

```
3093
```

## Help

`$ pagure --version`

```
0.2.2
```

`$ pagure --help`

```
Pagure client

Usage: pagure [--version] COMMAND

  Simple pagure CLI

Available options:
  -h,--help                Show this help text
  --version                Show version

Available commands:
  list                     list projects
  user                     list user repos
  group                    list group repos
  project                  show project details
  branches                 list project branches
  git-url                  show project repo's git urls
  issues                   list project issues
  issue                    show project issue
  users                    list users
  username                 fullname of user
  userinfo                 show user details
  groups                   list groups
  groupinfo                show group details
```
Use `--help` to get help on individual commands:


## Installation
pagure-cli is packaged in Fedora and EPEL 9: <https://src.fedoraproject.org/rpms/pagure-cli>

## Build from source
To build the latest release you will need cabal-install and ghc, or stack:

`stack install pagure-cli` or `cabal install pagure-cli`.

Or to build from the git source, run the commands without the package name.

## Contributions
Pagure rest API can be found on pagure servers: eg <https://pagure.io/api/0>.
There are still many unsupported commands and options.
Please open a ticket or PR to request adding more at
<https://github.com/juhp/pagure-cli>.

Also part of this client uses the simple
[pagure-hs](https://hackage.haskell.org/package/pagure) bindings.

## Other pagure clients
After writing the initial version I discovered that
Ricky Elrod (relrod) had made <https://github.com/fedora-infra/pagure-cli>.

There is a library client in Rust <https://pagure.io/ironthree/pagure-rs>
by decathorpe.