sip/README.md

# Sip (alternative)
CLI for interacting with Gitea

[![Build Status](https://drone.gitea.com/api/badges/jolheiser/sip/status.svg)](https://drone.gitea.com/jolheiser/sip)

### 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.
Rename project to Sip Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 21:50:02 +01:00			`# Sip (alternative)`
Split up funcs, add PR create/status/checkout Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 06:28:11 +01:00			`CLI for interacting with Gitea`

Add Drone and releases (#2) Move comment to appease linter Signed-off-by: jolheiser <john.olheiser@gmail.com> Add Drone and releases Signed-off-by: jolheiser <john.olheiser@gmail.com> Co-authored-by: jolheiser <john.olheiser@gmail.com> Reviewed-on: https://gitea.com/jolheiser/sip/pulls/2 2020-02-18 16:51:10 +01:00			`[![Build Status](https://drone.gitea.com/api/badges/jolheiser/sip/status.svg)](https://drone.gitea.com/jolheiser/sip)`

Split up funcs, add PR create/status/checkout Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 06:28:11 +01:00			`### 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.

Rename project to Sip Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 21:50:02 +01:00			* Configuration `sip config`
			* Change the default `origin` remote name `sip config origin`
			* Change the default `upstream` remote name `sip config upstrea`
Move log in/out commands to tokens command Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-18 03:57:51 +01:00			* 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...
Split up funcs, add PR create/status/checkout Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 06:28:11 +01:00			`* Authenticate with username/password to get a new token without leaving the terminal`
Move log in/out commands to tokens command Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-18 03:57:51 +01:00			* Remove access tokens `sip tokens remove`
Rename project to Sip Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 21:50:02 +01:00			* Repository status `sip repo`
Split up funcs, add PR create/status/checkout Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 06:28:11 +01:00			* Get basic information about the `upstream` repository
Rename project to Sip Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 21:50:02 +01:00			* Issue search `sip issues`
Split up funcs, add PR create/status/checkout Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 06:28:11 +01:00			`* Search issues based on keyword(s)`
Rename project to Sip Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 21:50:02 +01:00			* Create a new issue `sip issues create`
			* Pull request search `sip pulls`
Split up funcs, add PR create/status/checkout Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 06:28:11 +01:00			`* Search pull requests based on keyword(s)`
Rename project to Sip Signed-off-by: jolheiser <john.olheiser@gmail.com> 2020-02-17 21:50:02 +01:00			* Create a new pull request `sip pulls create`
			* Check pull request status (default based on current branch) `sip pulls status`
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 05:58:02 +01:00			* 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.