Skip to content

CLI Reference

This page provides documentation for our command line tools.

proxystore-globus-auth

ProxyStore Globus Auth.

Usage:

proxystore-globus-auth [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • login: Authenticate with Globus Auth.
  • logout: Revoke and remove all Globus tokens.

proxystore-globus-auth login

Authenticate with Globus Auth.

This requests scopes for Globus Auth, Globus Transfer, and the ProxyStore relay server. Collections or scopes options can be strung together. E.g., request transfer scope for multiple collections with:

$ proxystore-globus-auth -c UUID -c UUID -c UUID

Usage:

proxystore-globus-auth login [OPTIONS]

Options:

Name Type Description Default
--collection, -c text Globus Collection UUID to request transfer scopes for. None
--scope, -s text Additional scope to request. None
--help boolean Show this message and exit. False

proxystore-globus-auth logout

Revoke and remove all Globus tokens.

Usage:

proxystore-globus-auth logout [OPTIONS]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-endpoint

Manage and start ProxyStore Endpoints.

Usage:

proxystore-endpoint [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--log-level choice (ERROR | WARNING | INFO | DEBUG) Minimum logging level. INFO
--help boolean Show this message and exit. False

Subcommands

  • check-nat: Check the type of NAT you are behind.
  • configure: Configure a new endpoint.
  • help: Show available commands and options.
  • list: List all user endpoints.
  • remove: Remove an endpoint.
  • start: Start an endpoint.
  • stop: Stop a detached endpoint.
  • test: Execute test commands on an endpoint.
  • version: Show the ProxyStore version.

proxystore-endpoint check-nat

Check the type of NAT you are behind.

Usage:

proxystore-endpoint check-nat [OPTIONS]

Options:

Name Type Description Default
--host text Network interface address to listen on. 0.0.0.0
--port integer Port to listen on. 54320
--help boolean Show this message and exit. False

proxystore-endpoint configure

Configure a new endpoint.

Usage:

proxystore-endpoint configure [OPTIONS] NAME

Options:

Name Type Description Default
--port integer Port to listen on. 8765
--relay-address text Relay server address. wss://relay.proxystore.dev
--relay-auth / --no-relay-auth boolean Disable relay server authentication. True
--relay-server / --no-relay-server boolean Disable connecting to the relay server on start. True
--peer-channels integer Datachannels to use per peer connection. 1
--persist / --no-persist boolean Optionally persist data to a database. False
--help boolean Show this message and exit. False

proxystore-endpoint help

Show available commands and options.

Usage:

proxystore-endpoint help [OPTIONS]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-endpoint list

List all user endpoints.

Usage:

proxystore-endpoint list [OPTIONS]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-endpoint remove

Remove an endpoint.

Usage:

proxystore-endpoint remove [OPTIONS] NAME

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-endpoint start

Start an endpoint.

Usage:

proxystore-endpoint start [OPTIONS] NAME

Options:

Name Type Description Default
--detach / --no-detach boolean Run as daemon. True
--help boolean Show this message and exit. False

proxystore-endpoint stop

Stop a detached endpoint.

Usage:

proxystore-endpoint stop [OPTIONS] NAME

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-endpoint test

Execute test commands on an endpoint.

Usage:

proxystore-endpoint test [OPTIONS] NAME COMMAND [ARGS]...

Options:

Name Type Description Default
--remote text Optional UUID of remote endpoint to use. None
--help boolean Show this message and exit. False

Subcommands

  • evict: Evict object from an endpoint.
  • exists: Check if object exists in an endpoint.
  • get: Get an object from an endpoint.
  • put: Put an object in an endpoint.

proxystore-endpoint test NAME evict

Evict object from an endpoint.

Usage:

proxystore-endpoint test NAME evict [OPTIONS] KEY

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-endpoint test NAME exists

Check if object exists in an endpoint.

Usage:

proxystore-endpoint test NAME exists [OPTIONS] KEY

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-endpoint test NAME get

Get an object from an endpoint.

Usage:

proxystore-endpoint test NAME get [OPTIONS] KEY

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-endpoint test NAME put

Put an object in an endpoint.

Usage:

proxystore-endpoint test NAME put [OPTIONS] DATA

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-endpoint version

Show the ProxyStore version.

Usage:

proxystore-endpoint version [OPTIONS]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

proxystore-relay

Run a relay server instance.

The relay server is used by clients to establish peer-to-peer WebRTC connections. If no configuration file is provided, a default configuration will be created from RelayServingConfig(). The remaining CLI options will override the options provided in the configuration object.

Usage:

proxystore-relay [OPTIONS]

Options:

Name Type Description Default
--config, -c text Configuration file. None
--host text Interface to bind to. None
--port integer Port to bind to. None
--log-dir text Logging directoryy. None
--log-level choice (CRITICAL | ERROR | WARNING | INFO | DEBUG) Minimum logging level. None
--help boolean Show this message and exit. False