# Command-line Interface

# Usage

machinable <command> [options]

# -v, --version

Prints the machinable version number

# execute

machinable execute [OPTIONS] EXPERIMENT

Executes an EXPERIMENT

# Options

  • --storage TEXT Storage for this execution.
  • --engine TEXT Engine used during execution
  • --project TEXT Project directory
  • --seed TEXT Seed used in this execution

# server

WARNING

This feature is currently under development

Launches a server

# vendor

# fetch

Fetch dependencies of the current project

# --help

Use the --help option to inspect options

Usage: cli [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --version  Prints the version number
  --help         Show this message and exit.

Commands:
  app
  execute    Executes an EXPERIMENT
  execution  Resumes an execution from a storage URL
  server
  vendor

Usage: cli vendor [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  fetch

Usage: cli vendor fetch [OPTIONS]

Options:
  --help  Show this message and exit.





Usage: cli execute [OPTIONS] EXPERIMENT

  Executes an EXPERIMENT

Options:
  --storage TEXT  Storage for this execution.
  --engine TEXT   Engine used during execution
  --project TEXT  Project directory
  --seed TEXT     Seed used in this execution
  --help          Show this message and exit.



Usage: cli execution [OPTIONS] URL

  Resumes an execution from a storage URL

Options:
  --storage TEXT     Storage for this execution.
  --engine TEXT      Engine used during execution
  --project TEXT     Project directory.
  --checkpoint TEXT  Optional checkpoint specification
  --version TEXT     Optional configuration override
  --seed TEXT        Seed override. If unspecified, the pre-defined seed will
                     be used for exact reproduction

  --help             Show this message and exit.



Usage: cli server [OPTIONS]

Options:
  --host TEXT       Host
  --port INTEGER    Port
  --log-level TEXT  Log level
  --help            Show this message and exit.



Usage: cli app [OPTIONS]

Options:
  --help  Show this message and exit.