1
0
mirror of https://gitea.com/jolheiser/sip synced 2024-11-26 07:33:48 +01:00
sip/README.md
John Olheiser df58f223f2 Add search filters (#8)
Exclude Match from gocognit

Add search filters

Signed-off-by: jolheiser <john.olheiser@gmail.com>

Co-authored-by: jolheiser <john.olheiser@gmail.com>
Reviewed-on: https://gitea.com/jolheiser/sip/pulls/8
2020-02-27 04:58:02 +00:00

2.0 KiB

Sip (alternative)

CLI for interacting with Gitea

Build Status

Features

Understands the concepts of an origin vs remote repository.
By default uses remotes origin and upstream.
If no upstream repository is found, upstream becomes synonymous with origin for the sake of defaults.

  • Configuration sip config
    • Change the default origin remote name sip config origin
    • Change the default upstream remote name sip config upstrea
  • Tokens sip tokens
    • List current available access tokens
    • Generate a new token from CLI sip token create <token>
      • If <token> is present, add new access token, otherwise...
      • Authenticate with username/password to get a new token without leaving the terminal
    • Remove access tokens sip tokens remove
  • Repository status sip repo
    • Get basic information about the upstream repository
  • Issue search sip issues
    • Search issues based on keyword(s)
    • Create a new issue sip issues create
  • Pull request search sip pulls
    • Search pull requests based on keyword(s)
    • Create a new pull request sip pulls create
    • Check pull request status (default based on current branch) sip pulls status
    • Checkout a pull request to test locally sip pulls checkout

Search filters

Sip supports certain search filters for issues/PRs.
Anything in the query that doesn't match one of the below filters will be sent as a keyword

  • State is:open is:closed is:merged - only the last state in the query will be applied
  • Author author:jolheiser - only the last author in the query will be applied
  • Labels label:bug label:feature - all labels must apply to return results
  • Milestone mileston:v1.0.0 - only the last milestone in the query will be applied

e.g. test is:open query author:jolheiser milestone:0.2.0 will search for issues/PRs with keywords test query that are open, authored by jolheiser, and in the 0.2.0 milestone.