Skip to content

enumeray connector configuration generate

Render a private version-1 host configuration plan.

Use when: Prepare accounts, roots, restricted launchers, capacity and native service files consistently.

Role and prerequisites: Connector owner and host administrator. No user profile or API access is used.

Terminal window
enumeray connector configuration generate --file host-setup.json --directory host-plan
Input Meaning and use
--file <FILE> Edited version-1 HostSetupSpec; start from a host-setup example in the connector guide.
--directory <DIRECTORY> New private output directory. Existing files and directories are preserved.

Every command also accepts the profile, API, JSON and timeout options.

Atomically creates a new private directory with plan.json, context.json, native service/launcher templates and REVIEW.md. Existing destinations are refused; no account, service or enrollment is changed.

Review and apply approved host preparation separately, enroll the connector, and run connector preflight as its intended OS account.

Exact syntax, defaults and accepted values
Render a version-1 host setup specification into a new private directory
Usage: enumeray connector configuration generate [OPTIONS] --file <FILE> --directory <DIRECTORY>
Options:
--api <API> User API origin override; credentials never cross origins. Host/runner commands use explicit configuration
--file <FILE> Version-1 host setup specification JSON containing reviewed site paths and identities
--directory <DIRECTORY> New private output directory for the plan, runtime configuration and host instructions
--profile <PROFILE> Named local user API/login profile; host/runner commands use explicit configuration [default: default]
--config <CONFIG> Private user profiles file; defaults to $XDG_CONFIG_HOME/enumeray/profiles.json or ~/.config/enumeray/profiles.json
--json Emit user API results as JSON (NDJSON for following logs) and runtime errors on stderr; host/runner output follows its own protocol
--timeout <TIMEOUT> User API HTTP timeout in seconds; live logs use it for read inactivity. Does not limit execution time [default: 60]
-h, --help Print help

Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.