https://github.com/mantono/giss
List GitHub issues from the command line
https://github.com/mantono/giss
api cli github issues pull-req rust
Last synced: 6 months ago
JSON representation
List GitHub issues from the command line
- Host: GitHub
- URL: https://github.com/mantono/giss
- Owner: mantono
- License: mit
- Created: 2019-11-04T22:29:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T07:50:32.000Z (about 1 year ago)
- Last Synced: 2024-04-09T08:49:34.663Z (about 1 year ago)
- Topics: api, cli, github, issues, pull-req, rust
- Language: Rust
- Homepage:
- Size: 429 KB
- Stars: 14
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# giss
*giss* is command line client to list GitHub issues and pull requests.
## Usage
All commands requires a valid [GitHub API token](https://github.com/settings/tokens). The application will automatically read the environment variable
`GITHUB_TOKEN`, but it can also be given when invoking the application with the `-t` or `--token` flag.
### Token Permissions
#### Classic Tokens
The token needs the permission `read:org` for reading **public** repositories. For **private** repositories is the `repo` permission also required.
| Permission | Required |
| :--------: | :------: |
| `read:org` | Yes |
| `repo` | Only for private repository access |
#### Fine-Grained Tokens
The following _repository_ **read** permissions are required:
- Issues
- Metadata
- Pull requests
### List Issues & Pull Requests
By default, simply invoking the name of the binary, `giss`, will list tickets that are either
- issues
- pull requets
- review requests
in the current repo.
If the command is not invoked from a Git repository, an explicit repository will have to given as an argument.
- `giss` - List open tickets in current repo
- `giss mantono/giss` - List open tickets in repository _giss_ that belongs to user/organization _mantono_
- `giss apple` - List open tickets in any repository in organization _apple_
- `giss apple microsoft google` - List tickets in any repository in organizations _apple_, _microsoft_ and _google_
- `giss rust-lang/rust apple/swift golang/go` - List open tickets in repositories for rust, swift and go
- `giss -c` - List only closed tickets in current repo
- `giss -oc` - List both open and closed tickets in current repo
- `giss -a` - List only open tickets assigned to user\* in current repo
- `giss -i` - List only open issues in current repo
- `giss -p` - List only open pull requests in current repo
- `giss -r` - List only review requests for user\*
- `giss -a kotlin` - List all open tickets assigned to user in any repository in orgranization _kotlin_
\*the user is determined by the owner of the token, unless overriden with the `--user` flag.
See `giss --help` for all available options.
```
USAGE:
giss [FLAGS] [OPTIONS] [--] [target]...
FLAGS:
-a, --assigned
Assigned only
Only include issues and pull requests assigned to user
-c, --closed
Show closed issues or pull requests
Include issues, pull request or review requests that are closed or merged
-D, --debug
Prind debug information
Print debug information about current build for binary, useful for when an issue is encountered and reported
-h, --help
Prints help information
-i, --issues
List issues
-L, --links
Show links
Show links to each issue or pull request in the output
-o, --open
Show open issues or pull requests
Include issues, pull request or review requests that are open. If neither this flag nor --closed/-c is
given, default behavior will be to display open issues or pull requests.
-p, --pull-requests
List pull requests
-r, --review-requests
List review requests
-V, --version
Prints version information
OPTIONS:
--colors
Set use of colors
Enable or disable output with colors. By default, the application will try to figure out if colors are
supported by the terminal in the current context, and use it if possible. Possible values are "on", "true",
"off", "false", "auto". [default: auto]
-l, --labels ...
Filter by label
Only include issues, pull requests or review reuests which has (all) the given label(s).
-n, --limit
Limit the number of issues or pull requests to list [default: 10]
-O, --order
Ordering
Can be either ascending (asc|ascending) or decending (desc|descending)
-P, --project
Filter by project
Only include isses, pull request or review requests which is assoicated with the given project.
-S, --search
Search
Search by a string, which must be present either in the title or the body of an issue or pull request.
-s, --sort-by
Sort by
Sort by any of the following properties; "created", "updated", "comments", "reactions"
-t, --token
GitHub API token
API token that will be used when authenticating towards GitHub's API [env: GITHUB_TOKEN]
-u, --user
Username
Username to use for the query. Will default to the username for the user of the token.
-v, --verbosity
Set verbosity level, 0 - 5
Set the verbosity level, from 0 (least amount of output) to 5 (most verbose). Note that logging level
configured via RUST_LOG overrides this setting. [default: 1]
ARGS:
...
Name of target(s)
Name of the targets for the action. Can be a combination of one or several repositories, organizations or
users. Any repository specified must be qualified with the owner or organization name. For example
'org/repo'. When no target is specified, repository in current directory will be used, if possible.
```
## Building
The application is built with cargo. Simply run the following command in the project directory.
```bash
cargo build --release
```
A binary will be created and put in directory `target/release`.
## Install
Run `cargo install --path .`