> ## Documentation Index
> Fetch the complete documentation index at: https://gitquarry.micr.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# inspect

> Reference for gitquarry inspect, including metadata-first output, README inclusion, and supported formats.

# `gitquarry inspect`

Inspect one explicit repository by `owner/repo`.

## Synopsis

```bash theme={null}
gitquarry inspect [OPTIONS] <OWNER/REPO>
```

## Behavior

`inspect` is metadata-first.

Default output includes:

* full name
* URL
* description
* stars and forks
* language and topics
* license
* created, updated, and pushed timestamps
* archived, template, and fork state
* open issue count
* latest release summary when available
* contributor count when available

README content is optional and explicit.

## Options

```bash theme={null}
--readme
--format pretty|json|toon|compact|csv
--progress auto|on|off
```

## Examples

Human-readable:

```bash theme={null}
gitquarry inspect rust-lang/rust
```

Structured JSON:

```bash theme={null}
gitquarry inspect rust-lang/rust --format json
```

Include README:

```bash theme={null}
gitquarry inspect rust-lang/rust --readme --format json
```

## Failure Shape

The repository argument must be in `owner/repo` form.

Example invalid input:

```bash theme={null}
gitquarry inspect bad/repo/shape
```

That fails before auth resolution with a clear error message and symbolic error code.
