Metadata-Version: 2.1
Name: gh-search
Version: 0.5.0
Summary: Github search from the cli
Home-page: https://github.com/janeklb/gh-search
Author: Janek Lasocki-Biczysko
Author-email: janek.lb@gmail.net
License: UNKNOWN
Description: # gh-search
        
        GitHub code search from your cli
        
        ## Features
        
        * Filters the search results (eg. ignore archived repositories or search for additional text in matched content)
        * View search results grouped by org/repository
        * Checks your core API rate limit (prevent accidentally consuming your entire core api quota)
        * Uses GitHub's [Rest API] (and therefore works with GitHub Enterprise)
        
        [Rest API]: https://docs.github.com/en/rest/reference/search#search-code
        
        ## Installation
        
        ```bash
        pip install gh-search
        ```
        
        ## Authentication
        
        A valid GitHub personal access token, with the `repo` scope, is required to retrieve search results.
        It can be set on a `GITHUB_TOKEN` envvar or passed to the script via the `--github-token` option.
        
        ## Usage
        
        Invoke with `gh-search` and pass a query string as the first argument. For example, to search for the string "usage" in this repo:
        ```bash
        gh-search usage repo:janeklb/gh-search
        ```
        
        _Note that `repo:` is a search qualifier natively supported by the GitHub Search API. See GitHub's [searching code] documentation to see what other qualifiers are available._
        
        [searching code]: https://docs.github.com/en/github/searching-for-information-on-github/searching-code
        
        `gh-search` also offers the following options
        
        - `-a`/`--include-archived`: include results from archived repos (default behaviour is to exclude results from archived repositories).
        - `-p TEXT`/`--path-filter TEXT`: similar to the `path:` search qualifier, but a bit more flexible as it does a string match on the path (rather than relying on GitHub's indexed path components). For example `-p cat` will show matches against a file called `mycat.json` whereas `path:cat` will not.
        - `-c TEXT`/`--content-filter TEXT`: include results with content that yields a match against a regular expression (`TEXT`). A lot more flexible than specifying an additional search term in the search query, which relies on how GitHub has indexed a file for searching.
        - `-l` / `--repos-with-matches`: only prints the names of the repos with matching results
        - `-v` / `--verbose`: verbose output, print information about the repos being scanned and ignored via filters
        
        ### Enterprise
        
        If you want to search against GitHub Enterprise set the `GITHUB_API_URL` envvar with a URL to the v3 api endpoint. eg. `GITHUB_API_URL=https://github.mycompany.net/api/v3`. You can also use the `--github-api-url` option for this.
        
        ## Developing
        
        - `make install-dev` install dev dependencies (set up your own virtual environment first)
        - `make unit` run unit tests
        - `make lint` run linters
        
Platform: any
Description-Content-Type: text/markdown
Provides-Extra: dev
