enumeray

Use Enumeray for model execution, publication, connector management and connector operation.

Use when: You need to choose a workflow, set up a profile, or script the API without reading implementation code.

Role and prerequisites: All roles. Install enumeray, configure the API and log in. Use an account or delegated token with the required permissions. Example IDs must be replaced with IDs from your service.

Example

enumeray --profile research auth configure https://enumeray.example.org
enumeray --profile research auth login
enumeray --profile research --json model list

Resource names and UUIDs below are examples. Replace them with IDs returned by your service; --generation 1 is valid only if the latest response reports generation 1.

The CLI uses private profiles scoped to an API origin. An ENUMERAY_TOKEN environment variable can supply a token for automation; protect the process environment and do not put secrets in command arguments. Successful commands exit 0; operational errors exit 1 and argument parsing errors exit 2. User-command runtime failures provide JSON error codes with --json; argument errors remain plain text on stderr even with --json. Host commands use their explicit credentials and JSON results; compute-runner and hidden workers do not read user profiles. See the response for the reason; see HTTP/error conventions.

Profiles and global options

Input	Meaning and use
--api <API>	API origin override, for example https://enumeray.example.org. Stored credentials are used only for their original API origin; changing this does not transfer a login.
--profile <PROFILE>	Named local API/login profile; default is default. Put this before the command when switching services, for example enumeray --profile research model list.
--config <CONFIG>	Private profiles.json path; default is $XDG_CONFIG_HOME/enumeray/profiles.json, or ~/.config/enumeray/profiles.json. Use a separate file for an isolated automation identity.
--json	With run logs --follow or analysis logs --follow, emit newline-delimited {event,id,data} records and a final run record. Other commands emit the existing compact JSON response on stdout and runtime JSON errors on stderr for scripts. Argument parsing errors remain plain text on stderr with exit 2, including with --json. Native commands otherwise show human tables, details and receipts, including when redirected. The raw api command retains pretty JSON. Progress and previews before applying changes go to stderr.
--timeout <TIMEOUT>	Per-request HTTP timeout in seconds, default 60; in live streams this bounds connection/read inactivity. It does not set an execution deadline. Local observation deadlines also bound requests.

Choose a subcommand

Command	Purpose
compatibility	Inspect the executable and compare an explicitly selected installation without changing service or execution state.
setup	Guide or resume connector setup and a first model candidate trial.
compute-runner	Run one typed, credential-free compute protocol operation on an execution host.
auth	Configure service profiles, authenticate and manage delegated API tokens.
connector	Manage connectors and operate their host runtimes.
model	Create author projects and govern model publications, ownership and history.
access	Request, invite, approve or restrict permission to run a model.
run	Inspect accepted run history, diagnostics and evidence by ID.
artifact	Upload reusable input files and verify downloaded scientific or diagnostic files.
collection	Upload, inspect and selectively download immutable file collections.
analysis	Manage one analysis directory from reviewed inputs through verified results.
api	Call a documented management API endpoint on the selected origin.

Result and next step

Choose a subcommand below. The group itself performs no operation.

Start with your role’s workflow, then choose a command family below.

Exact syntax, defaults and accepted values

Model execution and connector management

Usage: enumeray [OPTIONS] <COMMAND>

Commands:
  compatibility   Inspect installed build identity and compare an explicitly selected component set
  setup           Guide or resume connector setup and a first model candidate trial
  compute-runner  Credential-free runner on an SSH host or Slurm submission host
  auth            Configure API profiles, sign in and manage delegated tokens
  connector       Register and administer connectors or operate their local host runtime
  model           Create author projects and manage model publications, ownership and history
  access          Manage model access policies, invitations, requests and per-user blocks
  run             Inspect accepted run history, diagnostics and lifecycle by ID; execute through analysis directories
  artifact        Upload, inspect and download individual verified files
  collection      Upload, inspect and selectively download immutable file collections
  analysis        Keep one analysis's inputs, retry identities, run and verified results together
  api             Explicit HTTP escape hatch for new management APIs; limited to this API origin
  help            Print this message or the help of the given subcommand(s)

Options:
      --api <API>          User API origin override; credentials never cross origins. Host/runner commands use explicit configuration
      --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
  -V, --version            Print version