> For the complete documentation index, see [llms.txt](https://mikefarah.gitbook.io/yq/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mikefarah.gitbook.io/yq/operators/document-index.md).

# Document Index

Use the `documentIndex` operator (or the `di` shorthand) to select nodes of a particular document.

## Retrieve a document index

Given a sample.yml file of:

```yaml
a: cat
---
a: frog
```

then

```bash
yq '.a | document_index' sample.yml
```

will output

```yaml
0
---
1
```

## Retrieve a document index, shorthand

Given a sample.yml file of:

```yaml
a: cat
---
a: frog
```

then

```bash
yq '.a | di' sample.yml
```

will output

```yaml
0
---
1
```

## Filter by document index

Given a sample.yml file of:

```yaml
a: cat
---
a: frog
```

then

```bash
yq 'select(document_index == 1)' sample.yml
```

will output

```yaml
a: frog
```

## Filter by document index shorthand

Given a sample.yml file of:

```yaml
a: cat
---
a: frog
```

then

```bash
yq 'select(di == 1)' sample.yml
```

will output

```yaml
a: frog
```

## Print Document Index with matches

Given a sample.yml file of:

```yaml
a: cat
---
a: frog
```

then

```bash
yq '.a | ({"match": ., "doc": document_index})' sample.yml
```

will output

```yaml
match: cat
doc: 0
---
match: frog
doc: 1
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mikefarah.gitbook.io/yq/operators/document-index.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.