Skip to content

Api

Listen over stdin & stdout to communicate with a distant server using the JSON lines API.

distant api

Flags

  • --timeout <N>: maximum time (in seconds) to wait for a network request before timing out. By default, each request waits indefinitely.
distant api --help 
Listen over stdin & stdout to communicate with a distant server using the JSON lines API

Usage: distant api [OPTIONS]

Options:
      --cache <CACHE>                Location to store cached data [default: /home/runner/.cache/distant/cache.toml]
      --log-level <LOG_LEVEL>        Log level to use throughout the application [possible values: off, error, warn, info, debug, trace]
      --log-file <LOG_FILE>          Path to file to use for logging
      --timeout <TIMEOUT>            Represents the maximum time (in seconds) to wait for a network request before timing out
      --config <CONFIG_PATH>         Configuration file to load instead of the default paths
      --connection <CONNECTION>      Specify a connection being managed
      --unix-socket <UNIX_SOCKET>    Override the path to the Unix socket used by the manager (unix-only)
      --windows-pipe <WINDOWS_PIPE>  Override the name of the local named Windows pipe used by the manager (windows-only)
  -h, --help                         Print help