codex index cli command

docs-builder codex index <config> [options]

Auth required

Index the built portal documentation into Elasticsearch.

Arguments

<config> string required

Path to the codex.yml configuration file.

Constraints: symbolic links not allowed, must exist, extensions: yml, yaml, supports ~ home expansion

Options

--endpoint string

-es,--endpoint, Elasticsearch endpoint URL. Falls back to env DOCUMENTATION_ELASTIC_URL.

Constraints: must be a http or https URI

--api-key string

API key for authentication. Falls back to env DOCUMENTATION_ELASTIC_APIKEY.

--username string

Username for basic authentication. Falls back to env DOCUMENTATION_ELASTIC_USERNAME.

--password string

Password for basic authentication. Falls back to env DOCUMENTATION_ELASTIC_PASSWORD.

--[no-]ai-enrichment

Enable AI enrichment of documents using LLM-generated metadata (enabled by default).

--search-num-threads int

Number of search threads for the inference endpoint.

Constraints: between 1 and 128

--index-num-threads int

Number of index threads for the inference endpoint.

Constraints: between 1 and 128

--[no-]eis

Use the Elastic Inference Service to bootstrap the inference endpoint (enabled by default).

--bootstrap-timeout string

How long to wait for the inference endpoint to become ready (e.g. 4m, 90s).

Constraints: duration between "1s" and "60m"

--[no-]force-reindex

Force a full reindex, discarding any incremental state.

--buffer-size int

Number of documents per bulk request.

Constraints: between 1 and 10000

--max-retries int

Number of retry attempts for failed bulk items.

Constraints: between 0 and 20

--[no-]debug-mode

Log every Elasticsearch request and response body; append ?pretty to all requests.

--proxy-address string

Route requests through this proxy URL.

Constraints: must be a http or https URI

--proxy-username string

Proxy server username.

--proxy-password string

Proxy server password.

--[no-]disable-ssl-verification

Disable SSL certificate validation. Use only in controlled environments.

--certificate-fingerprint string

SHA-256 fingerprint of a self-signed server certificate.

--certificate-path string

Path to a PEM or DER certificate file for SSL validation.

Constraints: symbolic links not allowed, must exist, extensions: pem, der, crt, cer, supports ~ home expansion

--[no-]certificate-not-root

Set when the certificate is an intermediate CA rather than the root.

-l --log-level enum

Minimum log level.

Values: trace, debug, information, warning, error, critical, none

Default: information

-c --config-source enum

Override the configuration source: local, remote

Values: local, remote, embedded

--[no-]skip-private-repositories

Skip cloning private repositories