Skip to main content

CLI Overview

Gitquarry has a deliberately small root command surface.

Root Commands

gitquarry search [OPTIONS] [QUERY]
gitquarry inspect [OPTIONS] <OWNER/REPO>
gitquarry auth login|status|logout
gitquarry config path|show
gitquarry version

Global Options

--host <HOST>
--generate-completion <bash|zsh|fish|powershell>
--help
--version

--host

Targets GitHub.com or a custom host. Accepted inputs:
  • bare hostname
  • full URL
  • explicit /api/v3 base
See GitHub Enterprise Hosts.

--generate-completion

Prints shell completion to stdout. Supported values:
  • bash
  • zsh
  • fish
  • powershell

Subcommand Roles

CommandRole
searchrepository discovery and ranking
inspectexplicit owner/repo inspection
authhost-scoped PAT management
configinspect effective config path and payload
versionprint the current version

Product Contract

The most important root-level rule is:
  • plain search stays close to native GitHub repository search
  • enhanced discovery stays explicit
That contract is defined in Search Behavior and the repo spec.