Skip to content
Simply SF logoSimply SF logoSimply CLI

Search

Section titled “simply gitlab search”

Search GitLab.

Flags

  • --limit <value> — Maximum number of results to return across all pages. (default: 20)
  • --scope <value> — What to search. (required; one of: projects, issues, merge_requests, milestones, wiki_blobs, commits, blobs, notes, users, snippet_titles)
  • --query <value> — The search term. (required)
  • --project <value> — Search within this project id or path.
  • --group <value> — Search within this group id or path.

Connection

  • -e, --env-file <value> — Path to a .env file holding connection settings.
  • --gitlab-url <value> — Base URL of the GitLab instance. Defaults to https://gitlab.com. (env: GITLAB_URL)
  • --gitlab-token <value> — Personal, project, or group access token. (env: GITLAB_TOKEN)

Global

  • --json — the raw API payload, for scripts and agents.

Searches the whole instance by default, or one project with —project, or one group with —group. These are three different GitLab endpoints, and they do not accept the same scopes: projects and users are instance-wide only, while a project search can look at notes.

The blobs, commits, wiki_blobs, notes, and snippet_titles scopes need Advanced Search (Elasticsearch) enabled on the instance. Where it is not, GitLab answers with an empty list and a 200 rather than an error, so an empty result for one of those scopes is reported here as possibly meaning “not enabled” rather than “no matches”.

Examples

Terminal window
simply gitlab search --scope projects --query platform
Terminal window
simply gitlab search --scope blobs --query UMCN_Account --project group/project
Terminal window
simply gitlab search --scope merge_requests --query "flaky test" --group my-group --json