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 tree [OPTIONS] <OWNER/REPO>
gitquarry code [OPTIONS] <OWNER/REPO> <PATTERN>
gitquarry compare [OPTIONS] <OWNER/REPO>...
gitquarry source path [OPTIONS] <SPEC>
gitquarry recipe run <FILE>
gitquarry mcp
gitquarry agent
gitquarry skills [list]
gitquarry skills get <NAME> [--full]
gitquarry skills path [NAME]
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
treeno-clone repository tree inspection
codeno-clone repository file content search
compareside-by-side explicit repository comparison
sourceexplicit opensrc-backed source retrieval
recipechecked-in TOML search recipe execution
mcpstdio Model Context Protocol server for agents
agentembedded guide for AI agents using the CLI
skillsembedded, version-matched CLI usage skills
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
  • remote tree and code inspection do not clone repositories
  • side-by-side comparison only runs for explicit repository inputs
  • checked-in recipes map to visible search flags rather than hidden defaults
  • MCP mode exposes the same CLI workflows to agents over stdio JSON-RPC
  • source fetching stays explicit through source path
That contract is defined in Search Behavior and the repo spec.