inndx/
GitHub

CLI

Every inndx command-line subcommand and what it does.

The inndx binary is the entry point for every deployment mode and operational task. This page documents each subcommand. It describes what the binary can do; for deployment procedures that use these commands, see your onboarding materials.

Every subcommand reads the same configuration (see Configuration). The global --config-file flag, available on all subcommands, points at a configuration file:

FlagEnvironmentDescription
--config-file, -cINNDX_CONFIG_FILEPath to a configuration file.

Running services

Each service runs with its own subcommand: orchestrator, fetcher, parser, sink, and analytics. The dev subcommand runs all of them together in a single process for evaluation and local testing.

inndx orchestrator
inndx fetcher
inndx parser
inndx sink
inndx analytics

These subcommands, and dev, share the same flags:

FlagEnvironmentDescription
--hostINNDX_HOSTThe host the service's HTTP server binds to.
--portINNDX_PORTThe port the service's HTTP server binds to.
--no-migrationsINNDX_NO_MIGRATIONSStart without applying pending database migrations.
inndx dev --port 8022

Running a single job

The run subcommand executes one crawl job from a manifest file in a single process, without standing up a long-running server. It is the quickest way to try a manifest.

inndx run my-crawl.yml
Argument or flagEnvironmentDescription
<file path>nonePath to the crawl manifest file (YAML or JSON). Required.
--tenant-id, -tnoneThe tenant to run the job under. Defaults to the configured default tenant.
--no-migrationsINNDX_NO_MIGRATIONSRun without applying pending database migrations.

Database migrations

The migrate subcommand applies any pending database migrations and exits. Run it before starting services against a new or upgraded database.

inndx migrate

It takes no subcommand-specific flags beyond the global --config-file.

Inspecting configuration

The config subcommand prints the fully resolved configuration (defaults merged with the config file and environment variables) and exits. Use it to confirm what a service will actually use.

inndx config
FlagDescription
--format, -fThe output format. Defaults to debug.

Global flags and environment

Beyond --config-file, every setting can be overridden with an environment variable using the INNDX__SECTION__FIELD convention (double underscores separate nesting levels). For example, INNDX__SERVER__PORT=8022 sets the server port. The full set of settings and their environment-variable names is documented in Configuration.

Search docs

Search the Self-host documentation