CLI Reference¶
This page provides documentation for our command line tools.
proxystore-globus-auth¶
ProxyStore Globus Auth.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
Subcommands
proxystore-globus-auth login¶
Authenticate with Globus Auth.
This requests scopes for Globus Auth and Globus Transfer. Collections can be strung together. E.g., request transfer scopes for multiple collections with:
$ proxystore-globus-auth login -c UUID -c UUID -c UUID
Providing UUIDs for High-Assurance GCS Mapped Collections will result in "Unknown Scope" errors during the login flow because those Collections do not use data_access. Do not provide those Collection UUIDs to the CLI. In this case, you may need to provide a domain for the collection:
$ proxystore-globus-auth login -d
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--collection, -c |
text | Globus Collection UUID to request data_access scopes for. | Sentinel.UNSET |
--domain, -d |
text | Require identities from the domain. | Sentinel.UNSET |
--force |
boolean | Force a login flow. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-globus-auth logout¶
Revoke and remove all Globus tokens.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint¶
Manage and start ProxyStore Endpoints.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--log-level |
choice (ERROR | WARNING | INFO | DEBUG) |
Minimum level of ProxyStore logs. | INFO |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
Subcommands
- client: Run client operations on endpoint NAME.
- configure: Configure a new endpoint.
- help: Show available commands and options.
- id: Print the ID of an endpoint.
- list: List all user endpoints.
- peers: Manage the peers an endpoint can communicate with.
- remove: Remove an endpoint.
- start: Start an endpoint.
- stop: Stop an endpoint running on this host.
- version: Show the ProxyStore version.
proxystore-endpoint client¶
Run client operations on endpoint NAME.
Operations are performed on the endpoint or, with --target, forwarded to a peer endpoint. These are useful for testing and debugging endpoints.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--target |
text | Optional ID of a peer endpoint to forward operations to. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
Subcommands
- evict: Evict object from an endpoint.
- exists: Check if object exists in an endpoint.
- get: Get an object from an endpoint.
- ping: Measure the latency of and path to a peer endpoint.
- put: Put an object in an endpoint.
proxystore-endpoint client NAME evict¶
Evict object from an endpoint.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint client NAME exists¶
Check if object exists in an endpoint.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint client NAME get¶
Get an object from an endpoint.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint client NAME ping¶
Measure the latency of and path to a peer endpoint.
The endpoint sends each ping to the peer given by --target and reports the time until it received the response and if the connection is direct or relayed. The first ping includes the time to connect to the peer if the endpoint is not already connected. Without --target, the time is the round trip between this client and the endpoint.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--count |
integer range (1 and above) |
Number of pings to send. | 4 |
--interval |
float range (0 and above) |
Seconds to wait between pings. | 0.5 |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint client NAME put¶
Put an object in an endpoint.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint configure¶
Configure a new endpoint.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--host |
text | Set endpoint host using the "ip", "fqdn", or a static address. | ip |
--port |
integer | Port to listen on. | None |
--peering / --no-peering |
boolean | Enable communication with peer endpoints. | True |
--relays |
text | Relays used for peering: "n0" (public relays run by n0), "none", or a comma-separated list of self-hosted relay URLs. | n0 |
--discovery |
choice (n0 | none) |
Service used to find the addresses of peers: "n0" (public DNS discovery run by n0) or "none". | n0 |
--persist / --no-persist |
boolean | Optionally persist data to a database. | False |
--tls / --no-tls |
boolean | Encrypt connections from clients with TLS (on by default). | True |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint help¶
Show available commands and options.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint id¶
Print the ID of an endpoint.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint list¶
List all user endpoints.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint peers¶
Manage the peers an endpoint can communicate with.
Two endpoints can only communicate if each endpoint has the other in its peers. Get the ID of an endpoint with "proxystore-endpoint id NAME".
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
Subcommands
- add: Allow endpoint NAME to communicate with peer PEER_ID.
- list: List the peers of endpoint NAME.
- remove: Stop endpoint NAME from communicating with peer PEER_NAME.
proxystore-endpoint peers add¶
Allow endpoint NAME to communicate with peer PEER_ID.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint peers list¶
List the peers of endpoint NAME.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint peers remove¶
Stop endpoint NAME from communicating with peer PEER_NAME.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint remove¶
Remove an endpoint.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint start¶
Start an endpoint.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--detach / --no-detach |
boolean | Run as daemon. | True |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint stop¶
Stop an endpoint running on this host.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
proxystore-endpoint version¶
Show the ProxyStore version.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | Sentinel.UNSET |