---
name: "custom-index"
section: "1"
platform: "linux"
package: "ncbi-entrez-direct"
version: "24.0.20250523+dfsg-1+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/custom-index"
---

# custom-index(1)

add a custom index to a local NCBI Entrez archive

## NAME

custom-index - add a custom index to a local NCBI Entrez archive

## SYNOPSIS

**custom-index** *helper* *field* ...

## DESCRIPTION

**custom-index** adds a custom index for one or more specified fields to a local NCBI Entrez Archive on the basis of a supplied helper command that produces an Entrez-style XML index. On Debian systems, some such helpers are **/usr/share/doc/ncbi-entrez-direct/examples/idx-\***.

## OPTIONS

- *helper*

  Helper command into which to pipe each uncompressed document.

- *field*

  Name of a field being indexed (*e.g.*, **ANUM**).

## ENVIRONMENT

- **EDIRECT\_LOCAL\_ARCHIVE**

  Local archive directory to use; expected to hold an absolute path.

- **EDIRECT\_LOCAL\_WORKING**

  Directory to hold intermediate subtrees; expected to hold an absolute path. Defaults to the local archive directory when not set.

## SEE ALSO

[**archive-pubmed**(1)](/archive-pubmed/1.md), [**rchive**(1)](/rchive/1.md), [**xtract**(1)](/xtract/1.md).