CLI documentation#
skyplane cp 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
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
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.3/profiles/throughput.csv
- --solver-verbose, --no-solver-verbose#
- Default:
False
Arguments
- SRC#
Required argument
- DST#
Required argument
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
- --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.3/profiles/throughput.csv
- --solver-verbose, --no-solver-verbose#
- Default:
False
Arguments
- SRC#
Required argument
- DST#
Required argument
ssh#
SSH into a running gateway.
skyplane ssh [OPTIONS]
deprovision#
Deprovision all resources created by skyplane.
skyplane deprovision [OPTIONS]