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.
$ npm install -g wit-gitlab-search
To finish the installation you need to configure the personal access token you've created previously:
$ wit-gitlab-search setup <your personal access token>
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.
You can decide where that file is saved when invoking the setup command, see more details in its help:
$ wit-gitlab-search setup --help
Searching through all the repositories you've got access to:
$ wit-gitlab-search [options] [command] <search-term> e.g. DEBUG=1 wit-gitlab-search -g 10036 -b branch_name keyword Options: --version output the version number --groups <group-names> group(s) to find repositories in (separated with comma) --filename <filename> only search for contents in given a file, glob matching with wildcards (*) --extension <file-extension> only search for contents in files with given extension --path <path> only search in files in the given path --help output usage information --branch search using this branch, otherwise use project's default Commands: setup [options] <personal-access-token> 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:
$ wit-gitlab-search setup --help Usage: setup [options] <personal-access-token> e.g. wit-gitlab-search setup --ignore-ssl --concurrency 5 --api-domain https://gitlab.company.com/ token create configuration file Options: --ignore-ssl ignore invalid SSL certificate from the GitLab API server --api-domain <name> 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> path to directory to save configuration file in (default: ".") --concurrency <number> 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
If something seems fishy or you're just curious what
wit-gitlab-search does under the hood, enabling debug logging helps:
$ DEBUG=1 wit-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