pagure-cli-0.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)
[![Build status](https://secure.travis-ci.org/juhp/pagure-cli.svg)](https://travis-ci.org/juhp/pagure-cli)
[![Copr build](https://copr.fedorainfracloud.org/coprs/petersen/pagure-cli/package/pagure-cli/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/petersen/pagure-cli/)

A [pagure](https://docs.pagure.org/pagure/) client for querying
projects and users.

## 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 emacs\*
emacs
:
```
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 -s pagure.io --count mattdm
93
```

## List groups:

```
$ pagure groups
:
```

## More commands

- `branches` lists the git branches of a repo

- `issues` to query and list issues

- `users` to list usernames of users

- `username` shows the fullname of a user

- `git-url` shows the git urls for a repo

## Help

Use `--help` to get help on individual commands:

```
$ pagure list --help
Usage: pagure list [-s|--server SERVER] [-c|--count] [-U|--url] [-j|--json]
                   [(-F|--only-forks) | (-f|--include-forks)]
                   [-n|--namespace NAMESPACE]
                   [(-o|--owner OWNER) | (-u|--username USERNAME)] [PATTERN]
  list projects

Available options:
  -s,--server SERVER       Pagure server
  -c,--count               Show number only
  -U,--url                 Print API url
  -j,--json                Print raw json response
  -F,--only-forks          Only list forks
  -f,--include-forks       Include forks [default: ignore forks]
  -n,--namespace NAMESPACE Specify project repo namespace
  -o,--owner OWNER         Projects with certain owner
  -u,--username USERNAME   Projects to which username can commit
  -h,--help                Show this help text
```

## Installation

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

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

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

## Binaries

If you are using Fedora you can install the package from my
[copr repo](https://copr.fedorainfracloud.org/coprs/petersen/pagure-cli/).

## 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.

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