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#

Initialize the Skyplane CLI with your cloud credentials

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#

Copy files between any two cloud object stores

skyplane cp [OPTIONS] SRC DST

Options

-r, --recursive#

If true, will copy objects at folder prefix recursively

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

--max-connections <max_connections>#

Number of connections per gateway

Default:

32

--solver <solver>#

Solver to use for transfer

Default:

direct

-t, --tput <solver_required_throughput_gbits>#

Required throughput to be solved for in Gbps

Default:

1

Arguments

SRC#

Required argument

DST#

Required argument

sync#

Sync files between any two cloud object stores

skyplane sync [OPTIONS] SRC DST

Options

--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

--max-connections <max_connections>#

Number of connections per gateway

Default:

32

--solver <solver>#

Solver to use for transfer

Default:

direct

-t, --tput <solver_required_throughput_gbits>#

Required throughput to be solved for

Default:

1

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]

Options

-a, --all#

Deprovision all resources including networks.

Default:

False

--filter-client-id <filter_client_id>#

Only deprovision instances with this client ID under the instance tag.