Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phillipj/gitlab-search
Command line tool to search for contents in GitLab repositories
https://github.com/phillipj/gitlab-search
gitlab reasonml
Last synced: 4 days ago
JSON representation
Command line tool to search for contents in GitLab repositories
- Host: GitHub
- URL: https://github.com/phillipj/gitlab-search
- Owner: phillipj
- License: mit
- Created: 2019-03-16T23:27:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-21T11:00:03.000Z (about 1 year ago)
- Last Synced: 2024-10-14T12:08:37.842Z (3 months ago)
- Topics: gitlab, reasonml
- Language: Reason
- Size: 64.5 KB
- Stars: 304
- Watchers: 10
- Forks: 37
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitLab Search 
This is a command line tool that allows you to search for contents across all your GitLab repositories.
That's something GitLab doesn't provide out of the box for non-enterprise users, but is extremely valuable
when needed.
## Prerequisites
1. Install [Node.js](https://nodejs.org)
2. Create a [personal GitLab access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token) with the `read_api` scope.
## Installation
```
$ npm install -g gitlab-search
```
To finish the installation you need to configure the personal access token you've created previously:
```
$ gitlab-search setup
```
That will create a `.gitlabsearchrc` file in the current directory. That configuration file can be placed
in different places on your machine, valid locations are described in the [rc package's README](https://www.npmjs.com/package/rc#standards).
You can decide where that file is saved when invoking the setup command, see more details in its help:
```
$ gitlab-search setup --help
```
## Usage
Searching through all the repositories you've got access to:
```
$ gitlab-search [options] [command]
Options:
-V, --version output the version number
-g, --groups group(s) to find repositories in (separated with comma)
-f, --filename only search for contents in given a file, glob matching with wildcards (*)
-e, --extension only search for contents in files with given extension
-p, --path only search in files in the given path
-a, --archive [all,only,exclude] search only in archived projects, exclude archived projects, search in all projects (default is all)
-h, --help output usage information
Commands:
setup [options] create configuration file
```
## Use with Self-Managed GitLab
To search a self-hosted installation of GitLab, `setup` has options for, among other things, setting a custom domain:
```
$ gitlab-search setup --help
Usage: setup [options]
create configuration file
Options:
--ignore-ssl ignore invalid SSL certificate from the GitLab API server
--api-domain domain name or root URL of GitLab API server,
specify root URL (without trailing slash) to use HTTP instead of HTTPS (default: "gitlab.com")
--dir path to directory to save configuration file in (default: ".")
--concurrency limit the amount of concurrent HTTPS requests sent to GitLab when searching,
useful when *many* projects are hosted on a small GitLab instance
to avoid overwhelming the instance resulting in 502 errors (default: 25)
-h, --help display help for command
```
## Debugging
If something seems fishy or you're just curious what `gitlab-search` does under the hood, enabling debug logging helps:
```
$ DEBUG=1 gitlab-search here-is-my-search-term
Requesting: GET https://gitlab.com/api/v4/groups?per_page=100
Using groups: name-of-group1, name-of-group2
Requesting: GET https://gitlab.com/api/v4/groups/42/projects?per_page=100
Requesting: GET https://gitlab.com/api/v4/groups/1337/projects?per_page=100
Using projects: hello-world, my-awesome-website.com
Requesting: GET https://gitlab.com/api/v4/projects/666/search?scope=blobs&search=here-is-my-search-term
Requesting: GET https://gitlab.com/api/v4/projects/999/search?scope=blobs&search=here-is-my-search-term
```
## License
MIT