Internal CLI documentation#
skyplane#
skyplane [OPTIONS] COMMAND [ARGS]...
Options
- --install-completion <install_completion>#
Install completion for the specified shell.
- Options
bash | zsh | fish | powershell | pwsh
- --show-completion <show_completion>#
Show completion for the specified shell, to copy it or customize the installation.
- Options
bash | zsh | fish | powershell | pwsh
aws#
skyplane aws [OPTIONS] COMMAND [ARGS]...
cp-datasync#
skyplane aws cp-datasync [OPTIONS] SRC_BUCKET DST_BUCKET PATH
Arguments
- SRC_BUCKET#
Required argument
- DST_BUCKET#
Required argument
- PATH#
Required argument
vcpu-limits#
List the vCPU limits for each region.
skyplane aws vcpu-limits [OPTIONS]
Options
- --quota-code <quota_code>#
- Default
L-1216C47A
azure#
skyplane azure [OPTIONS] COMMAND [ARGS]...
get-valid-skus#
skyplane azure get-valid-skus [OPTIONS]
Options
- -r, --regions <regions>#
- Default
- --prefix <prefix>#
Filter by prefix
- Default
- --top-k <top_k>#
Print top k entries
- Default
-1
config#
skyplane config [OPTIONS] COMMAND [ARGS]...
get#
Get a config value.
skyplane config get [OPTIONS] KEY
Arguments
- KEY#
Required argument
list#
List all available config keys
skyplane config list [OPTIONS]
set#
Set a config value.
skyplane config set [OPTIONS] KEY VALUE
Arguments
- KEY#
Required argument
- VALUE#
Required argument
cp#
cp copies a file or folder from one location to another. If the source is on an object store, it will copy all objects with that prefix. If it is a local path, it will copy the entire file or directory tree.
By default, it will copy objects using a direct connection between instances. However, if you would like to use the solver, call –solve. Note that the solver requires a throughput grid file to be specified. We provide a default one but it may be out-of-date.
- param src
Source prefix to copy from
- type src
str
- param dst
The destination of the transfer
- type dst
str
- param recursive
If true, will copy objects at folder prefix recursively
- type recursive
bool
- param reuse_gateways
If true, will leave provisioned instances running to be reused. You must run skyplane deprovision to clean up.
- type reuse_gateways
bool
- param debug
If true, will write debug information to debug directory.
- type debug
bool
- param multipart
If true, will use multipart uploads.
- type multipart
bool
- param confirm
If true, will not prompt for confirmation of transfer.
- type confirm
bool
- param max_instances
The maximum number of instances to use per region (default: 1)
- type max_instances
int
- param solve
If true, will use solver to optimize transfer, else direct path is chosen
- type solve
bool
- param solver_required_throughput_gbits
The required throughput in Gbps when using the solver (default: 4)
- type solver_required_throughput_gbits
float
- param solver_throughput_grid
The throughput grid profile to use for the solver, defaults to author-provided profile
- type solver_throughput_grid
Path
- param solver_verbose
If true, will print out the solver’s output, defaults to False
- type solver_verbose
bool (optional)
skyplane cp [OPTIONS] SRC DST
Options
- -r, --recursive#
If true, will copy objects at folder prefix recursively
- Default
False
- --reuse-gateways, --no-reuse-gateways#
If true, will leave provisioned instances running to be reused
- Default
False
- --debug, --no-debug#
If true, will write debug information to debug directory.
- Default
False
- --multipart, --no-multipart#
If true, will use multipart uploads.
- Default
True
- -y, -f, --confirm#
Confirm all transfer prompts
- Default
False
- -n, --max-instances <max_instances>#
Number of gateways
- Default
1
- --solve, --no-solve#
If true, will use solver to optimize transfer, else direct path is chosen
- Default
False
- --solver-required-throughput-gbits <solver_required_throughput_gbits>#
Solver option: Required throughput in Gbps
- Default
4
- --throughput-grid <solver_throughput_grid>#
Throughput grid file
- Default
/home/docs/checkouts/readthedocs.org/user_builds/skyplane/checkouts/0.1.2/profiles/throughput.csv
- --solver-verbose, --no-solver-verbose#
- Default
False
Arguments
- SRC#
Required argument
- DST#
Required argument
deprovision#
Deprovision all resources created by skyplane.
skyplane deprovision [OPTIONS]
experiments#
skyplane experiments [OPTIONS] COMMAND [ARGS]...
dump-full-util-cost-grid#
skyplane experiments dump-full-util-cost-grid [OPTIONS]
Options
- --throughput-grid <throughput_grid>#
Throughput grid file
- Default
/home/docs/checkouts/readthedocs.org/user_builds/skyplane/checkouts/0.1.2/profiles/throughput.csv
get-max-throughput#
skyplane experiments get-max-throughput [OPTIONS] REGION_TAG
Arguments
- REGION_TAG#
Required argument
latency-grid#
skyplane experiments latency-grid [OPTIONS]
Options
- -aws <aws_region_list>#
- Default
- -azure <azure_region_list>#
- Default
- -gcp <gcp_region_list>#
- Default
- -gcp-standard <gcp_standard_region_list>#
- Default
- --enable-aws, --no-enable-aws#
- Default
True
- --enable-azure, --no-enable-azure#
- Default
True
- --enable-gcp, --no-enable-gcp#
- Default
True
- --enable-gcp-standard, --no-enable-gcp-standard#
- Default
True
- --aws-instance-class <aws_instance_class>#
AWS instance class to use
- Default
m5.large
- --azure-instance-class <azure_instance_class>#
Azure instance class to use
- Default
Standard_D2_v3
- --gcp-instance-class <gcp_instance_class>#
GCP instance class to use
- Default
n2-standard-4
throughput-grid#
skyplane experiments throughput-grid [OPTIONS]
Options
- --resume <resume>#
Resume from a past result. Pass the resulting CSV for the past result to resume. Default is None.
- --copy-resume-file, --no-copy-resume-file#
Copy the resume file to the output CSV. Default is True.
- Default
True
- -aws <aws_region_list>#
- Default
- -azure <azure_region_list>#
- Default
- -gcp <gcp_region_list>#
- Default
- -gcp-standard <gcp_standard_region_list>#
- Default
- --enable-aws, --no-enable-aws#
- Default
True
- --enable-azure, --no-enable-azure#
- Default
True
- --enable-gcp, --no-enable-gcp#
- Default
True
- --enable-gcp-standard, --no-enable-gcp-standard#
- Default
True
- --aws-instance-class <aws_instance_class>#
AWS instance class to use
- Default
m5.8xlarge
- --azure-instance-class <azure_instance_class>#
Azure instance class to use
- Default
Standard_D32_v5
- --gcp-instance-class <gcp_instance_class>#
GCP instance class to use
- Default
n2-standard-32
- --iperf3-runtime <iperf3_runtime>#
Runtime for iperf3 in seconds
- Default
5
- --iperf3-connections <iperf3_connections>#
Number of connections to test
- Default
64
util-grid-cost#
skyplane experiments util-grid-cost [OPTIONS] SRC DEST
Options
- --src-tier <src_tier>#
- Default
PREMIUM
- --dest-tier <dest_tier>#
- Default
PREMIUM
- --throughput-grid <throughput_grid>#
Throughput grid file
- Default
/home/docs/checkouts/readthedocs.org/user_builds/skyplane/checkouts/0.1.2/profiles/throughput.csv
Arguments
- SRC#
Required argument
- DEST#
Required argument
util-grid-throughput#
skyplane experiments util-grid-throughput [OPTIONS] SRC DEST
Options
- --src-tier <src_tier>#
- Default
PREMIUM
- --dest-tier <dest_tier>#
- Default
PREMIUM
- --throughput-grid <throughput_grid>#
Throughput grid file
- Default
/home/docs/checkouts/readthedocs.org/user_builds/skyplane/checkouts/0.1.2/profiles/throughput.csv
Arguments
- SRC#
Required argument
- DEST#
Required argument
init#
It loads the configuration file, and if it doesn’t exist, it creates a default one. Then it creates AWS, Azure, and GCP region list configurations.
- param reinit_azure
If true, will reinitialize the Azure region list and credentials
- type reinit_azure
bool
- param reinit_gcp
If true, will reinitialize the GCP region list and credentials
- type reinit_gcp
bool
- param disable_config_aws
If true, will disable AWS configuration (may still be enabled if environment variables are set)
- type disable_config_aws
bool
- param disable_config_azure
If true, will disable Azure configuration (may still be enabled if environment variables are set)
- type disable_config_azure
bool
- param disable_config_gcp
If true, will disable GCP configuration (may still be enabled if environment variables are set)
- type disable_config_gcp
bool
skyplane init [OPTIONS]
Options
- -y, --non-interactive#
Run non-interactively
- Default
False
- --reinit-azure, --no-reinit-azure#
- Default
False
- --reinit-gcp, --no-reinit-gcp#
- Default
False
- --disable-config-aws, --no-disable-config-aws#
- Default
False
- --disable-config-azure, --no-disable-config-azure#
- Default
False
- --disable-config-gcp, --no-disable-config-gcp#
- Default
False
replicate-random#
Replicate objects from remote object store to another remote object store.
skyplane replicate-random [OPTIONS] SRC_REGION DST_REGION [INTER_REGION]
Options
- -n, --num-gateways <num_gateways>#
Number of gateways
- Default
1
- -c, --num-outgoing-connections <num_outgoing_connections>#
Number of outgoing connections between each gateway
- Default
32
- -s, --size-total-mb <total_transfer_size_mb>#
Total transfer size in MB.
- Default
2048
- --chunk-size-mb <chunk_size_mb>#
Chunk size in MB.
- Default
8
- --use-bbr, --no-use-bbr#
If true, will use BBR congestion control
- Default
True
- --reuse-gateways, --no-reuse-gateways#
- Default
False
- --debug, --no-debug#
- Default
False
Arguments
- SRC_REGION#
Required argument
- DST_REGION#
Required argument
- INTER_REGION#
Optional argument
replicate-random-solve#
Replicate objects from remote object store to another remote object store.
skyplane replicate-random-solve [OPTIONS] SRC_REGION DST_REGION [INTER_REGION]
Options
- -n, --num-gateways <num_gateways>#
Number of gateways
- Default
1
- -c, --num-outgoing-connections <num_outgoing_connections>#
Number of outgoing connections between each gateway
- Default
32
- -s, --size-total-mb <total_transfer_size_mb>#
Total transfer size in MB.
- Default
2048
- --chunk-size-mb <chunk_size_mb>#
Chunk size in MB.
- Default
8
- --use-bbr, --no-use-bbr#
If true, will use BBR congestion control
- Default
True
- --reuse-gateways, --no-reuse-gateways#
- Default
False
- --solve, --no-solve#
If true, will use solver to optimize transfer, else direct path is chosen
- Default
False
- --solver-required-throughput-gbits <solver_required_throughput_gbits>#
Solver option: Required throughput in gbps.
- Default
2
- --throughput-grid <solver_throughput_grid>#
Throughput grid file
- Default
/home/docs/checkouts/readthedocs.org/user_builds/skyplane/checkouts/0.1.2/profiles/throughput.csv
- --solver-verbose, --no-solver-verbose#
- Default
False
- --debug, --no-debug#
- Default
False
Arguments
- SRC_REGION#
Required argument
- DST_REGION#
Required argument
- INTER_REGION#
Optional argument
solver#
skyplane solver [OPTIONS] COMMAND [ARGS]...
solve-single-hop#
skyplane solver solve-single-hop [OPTIONS] SRC DST
Options
- --throughput-grid <throughput_grid>#
Throughput grid file
- Default
/home/docs/checkouts/readthedocs.org/user_builds/skyplane/checkouts/0.1.2/profiles/throughput.csv
- --gbyte-to-transfer <gbyte_to_transfer>#
Gigabytes to transfer
- Default
1
- -o, --out <out>#
Output file for path.
Arguments
- SRC#
Required argument
- DST#
Required argument
solve-throughput#
skyplane solver solve-throughput [OPTIONS] SRC DST REQUIRED_THROUGHPUT_GBITS
Options
- --gbyte-to-transfer <gbyte_to_transfer>#
Gigabytes to transfer
- Default
1
- --max-instances <max_instances>#
Max number of instances per overlay region.
- Default
1
- --throughput-grid <throughput_grid>#
Throughput grid file
- Default
/home/docs/checkouts/readthedocs.org/user_builds/skyplane/checkouts/0.1.2/profiles/throughput.csv
- --solver-verbose, --no-solver-verbose#
- Default
False
- -o, --out <out>#
Output file for path.
- --visualize, --no-visualize#
- Default
False
Arguments
- SRC#
Required argument
- DST#
Required argument
- REQUIRED_THROUGHPUT_GBITS#
Required argument
ssh#
SSH into a running gateway.
skyplane ssh [OPTIONS]
sync#
‘sync` synchronizes files or folders from one location to another. If the source is on an object store, it will copy all objects with that prefix. If it is a local path, it will copy the entire file or directory tree.
By default, it will copy objects using a direct connection between instances. However, if you would like to use the solver, call –solve. Note that the solver requires a throughput grid file to be specified. We provide a default one but it may be out-of-date.
For each file in the source, it is copied over if the file does not exist in the destination, it has a different size in the destination, or if the source version of the file was more recently modified than the destination. This behavior is similar to ‘aws sync’.
- param src
Source prefix to copy from
- type src
str
- param dst
The destination of the transfer
- type dst
str
- param recursive
If true, will copy objects at folder prefix recursively
- type recursive
bool
- param reuse_gateways
If true, will leave provisioned instances running to be reused. You must run skyplane deprovision to clean up.
- type reuse_gateways
bool
- param debug
If true, will write debug information to debug directory.
- type debug
bool
- param multipart
If true, will use multipart uploads.
- type multipart
bool
- param confirm
If true, will not prompt for confirmation of transfer.
- type confirm
bool
- param max_instances
The maximum number of instances to use per region (default: 1)
- type max_instances
int
- param solve
If true, will use solver to optimize transfer, else direct path is chosen
- type solve
bool
- param solver_required_throughput_gbits
The required throughput in Gbps when using the solver (default: 4)
- type solver_required_throughput_gbits
float
- param solver_throughput_grid
The throughput grid profile to use for the solver, defaults to author-provided profile
- type solver_throughput_grid
Path
- param solver_verbose
If true, will print out the solver’s output, defaults to False
- type solver_verbose
bool (optional)
skyplane sync [OPTIONS] SRC DST
Options
- -r, --recursive#
If true, will copy objects at folder prefix recursively
- Default
False
- --reuse-gateways, --no-reuse-gateways#
If true, will leave provisioned instances running to be reused
- Default
False
- --debug, --no-debug#
If true, will write debug information to debug directory.
- Default
False
- -y, -f, --confirm#
Confirm all transfer prompts
- Default
False
- -n, --max-instances <max_instances>#
Number of gateways
- Default
1
- --multipart, --no-multipart#
If true, will use multipart uploads.
- Default
True
- --solve, --no-solve#
If true, will use solver to optimize transfer, else direct path is chosen
- Default
False
- --solver-required-throughput-gbits <solver_required_throughput_gbits>#
Solver option: Required throughput in Gbps
- Default
4
- --throughput-grid <solver_throughput_grid>#
Throughput grid file
- Default
/home/docs/checkouts/readthedocs.org/user_builds/skyplane/checkouts/0.1.2/profiles/throughput.csv
- --solver-verbose, --no-solver-verbose#
- Default
False
Arguments
- SRC#
Required argument
- DST#
Required argument