cloudscripts
=================

Cloud Scripts CLI

<!-- toc -->
* [Installation](#installation)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
<!-- installation -->
# Installation
To install on Linux or MacOS (or WSL under Windows), run the following from your shell:

```
curl -sSL https://skytapcscli.blob.core.windows.net/skytapcs-cli/cloudscripts-install.sh | bash
```

To install globally for all users, run the installation with `sudo`:

```
curl -sSL https://skytapcscli.blob.core.windows.net/skytapcs-cli/cloudscripts-install.sh | sudo bash
```

An uninstall script is provided in `~/.local/lib/cloudscripts/bin/uninstall.sh` for single-user installations or `/usr/share/cloudscripts/bin/uninstall.sh` for global installations.

To install natively on Windows, use one of the installers linked below.

* Windows installers:
  * [cloudscripts (win32-x64)](https://skytapcscli.blob.core.windows.net/skytapcs-cli/cloudscripts-latest-win32-x64.exe)
  * [cloudscripts (win32-arm64)](https://skytapcscli.blob.core.windows.net/skytapcs-cli/cloudscripts-latest-win32-arm64.exe)
* Other packages:
  * [cloudscripts (darwin-x64)](https://skytapcscli.blob.core.windows.net/skytapcs-cli/cloudscripts-latest-darwin-x64.tar.gz)
  * [cloudscripts (darwin-arm64)](https://skytapcscli.blob.core.windows.net/skytapcs-cli/cloudscripts-latest-darwin-arm64.tar.gz)
  * [cloudscripts (linux-x64)](https://skytapcscli.blob.core.windows.net/skytapcs-cli/cloudscripts-latest-linux-x64.tar.gz)
  * [cloudscripts (linux-arm64)](https://skytapcscli.blob.core.windows.net/skytapcs-cli/cloudscripts-latest-linux-arm64.tar.gz)
<!-- installationstop -->

# Usage
<!-- usage -->
```sh-session
$ npm install -g cloudscripts
$ cloudscripts COMMAND
running command...
$ cloudscripts (--version)
cloudscripts/0.1.67 linux-x64 node-v24.14.1
$ cloudscripts --help [COMMAND]
USAGE
  $ cloudscripts COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`cloudscripts build SRC-PATH`](#cloudscripts-build-src-path)
* [`cloudscripts build-host destroy`](#cloudscripts-build-host-destroy)
* [`cloudscripts build-host docker-access`](#cloudscripts-build-host-docker-access)
* [`cloudscripts build-host info`](#cloudscripts-build-host-info)
* [`cloudscripts build-host provision`](#cloudscripts-build-host-provision)
* [`cloudscripts build-host start`](#cloudscripts-build-host-start)
* [`cloudscripts build-host stop`](#cloudscripts-build-host-stop)
* [`cloudscripts build-host suspend`](#cloudscripts-build-host-suspend)
* [`cloudscripts cloud login`](#cloudscripts-cloud-login)
* [`cloudscripts cloud logout`](#cloudscripts-cloud-logout)
* [`cloudscripts help [COMMAND]`](#cloudscripts-help-command)
* [`cloudscripts images create NAME`](#cloudscripts-images-create-name)
* [`cloudscripts images destroy NAME`](#cloudscripts-images-destroy-name)
* [`cloudscripts images docker-access NAME`](#cloudscripts-images-docker-access-name)
* [`cloudscripts images info NAME`](#cloudscripts-images-info-name)
* [`cloudscripts images list`](#cloudscripts-images-list)
* [`cloudscripts login`](#cloudscripts-login)
* [`cloudscripts logout`](#cloudscripts-logout)
* [`cloudscripts new DESTINATION`](#cloudscripts-new-destination)
* [`cloudscripts push SRC-PATH`](#cloudscripts-push-src-path)
* [`cloudscripts run SRC-PATH`](#cloudscripts-run-src-path)
* [`cloudscripts scripts build SRC-PATH`](#cloudscripts-scripts-build-src-path)
* [`cloudscripts scripts destroy NAME`](#cloudscripts-scripts-destroy-name)
* [`cloudscripts scripts info NAME`](#cloudscripts-scripts-info-name)
* [`cloudscripts scripts list`](#cloudscripts-scripts-list)
* [`cloudscripts scripts new DESTINATION`](#cloudscripts-scripts-new-destination)
* [`cloudscripts scripts package SRC-PATH`](#cloudscripts-scripts-package-src-path)
* [`cloudscripts scripts pull NAME`](#cloudscripts-scripts-pull-name)
* [`cloudscripts scripts push SRC-PATH`](#cloudscripts-scripts-push-src-path)
* [`cloudscripts scripts run SRC-PATH`](#cloudscripts-scripts-run-src-path)
* [`cloudscripts templates list`](#cloudscripts-templates-list)

## `cloudscripts build SRC-PATH`

Build a script (alias for `cloudscripts scripts build SRC-PATH`)

```
USAGE
  $ cloudscripts build SRC-PATH

ARGUMENTS
  SRC-PATH  Source path

DESCRIPTION
  Build a script (alias for `cloudscripts scripts build SRC-PATH`)
```

_See code: [src/commands/build.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/build.ts)_

## `cloudscripts build-host destroy`

Destroy an existing Build Host in Kyndryl Cloud Uplift

```
USAGE
  $ cloudscripts build-host destroy [-f]

FLAGS
  -f, --force  Reset local Build Host state even if the remote environment cannot be deleted

DESCRIPTION
  Destroy an existing Build Host in Kyndryl Cloud Uplift
```

_See code: [src/commands/build-host/destroy.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/build-host/destroy.ts)_

## `cloudscripts build-host docker-access`

Display details for configuring the local Docker CLI for use with the Kyndryl Cloud Uplift-based Build Host

```
USAGE
  $ cloudscripts build-host docker-access

DESCRIPTION
  Display details for configuring the local Docker CLI for use with the Kyndryl Cloud Uplift-based Build Host
```

_See code: [src/commands/build-host/docker-access.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/build-host/docker-access.ts)_

## `cloudscripts build-host info`

Display Build Host configuration

```
USAGE
  $ cloudscripts build-host info

DESCRIPTION
  Display Build Host configuration
```

_See code: [src/commands/build-host/info.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/build-host/info.ts)_

## `cloudscripts build-host provision`

Create a Build Host in Kyndryl Cloud Uplift

```
USAGE
  $ cloudscripts build-host provision -r <value>

FLAGS
  -r, --region=<value>  (required) Destination region for the Build Host

DESCRIPTION
  Create a Build Host in Kyndryl Cloud Uplift
```

_See code: [src/commands/build-host/provision.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/build-host/provision.ts)_

## `cloudscripts build-host start`

Starts the Build Host in Kyndryl Cloud Uplift

```
USAGE
  $ cloudscripts build-host start

DESCRIPTION
  Starts the Build Host in Kyndryl Cloud Uplift
```

_See code: [src/commands/build-host/start.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/build-host/start.ts)_

## `cloudscripts build-host stop`

Shuts down the Build Host in Kyndryl Cloud Uplift

```
USAGE
  $ cloudscripts build-host stop

DESCRIPTION
  Shuts down the Build Host in Kyndryl Cloud Uplift
```

_See code: [src/commands/build-host/stop.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/build-host/stop.ts)_

## `cloudscripts build-host suspend`

Suspends the Build Host in Kyndryl Cloud Uplift

```
USAGE
  $ cloudscripts build-host suspend

DESCRIPTION
  Suspends the Build Host in Kyndryl Cloud Uplift
```

_See code: [src/commands/build-host/suspend.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/build-host/suspend.ts)_

## `cloudscripts cloud login`

Log into Kyndryl Cloud Uplift

```
USAGE
  $ cloudscripts cloud login [-a <value>] [-i] [-u <value>]

FLAGS
  -a, --api-token=<value>  API token
  -i, --api-token-stdin    Read API token from stdin
  -u, --username=<value>   Username

DESCRIPTION
  Log into Kyndryl Cloud Uplift
```

_See code: [src/commands/cloud/login.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/cloud/login.ts)_

## `cloudscripts cloud logout`

Log out from Kyndryl Cloud Uplift

```
USAGE
  $ cloudscripts cloud logout

DESCRIPTION
  Log out from Kyndryl Cloud Uplift
```

_See code: [src/commands/cloud/logout.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/cloud/logout.ts)_

## `cloudscripts help [COMMAND]`

Display help for cloudscripts.

```
USAGE
  $ cloudscripts help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for cloudscripts.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_

## `cloudscripts images create NAME`

Create a new image repository

```
USAGE
  $ cloudscripts images create NAME

ARGUMENTS
  NAME  Name of the image

DESCRIPTION
  Create a new image repository
```

_See code: [src/commands/images/create.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/images/create.ts)_

## `cloudscripts images destroy NAME`

Deletes an image

```
USAGE
  $ cloudscripts images destroy NAME

ARGUMENTS
  NAME  Name of the image

DESCRIPTION
  Deletes an image
```

_See code: [src/commands/images/destroy.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/images/destroy.ts)_

## `cloudscripts images docker-access NAME`

Retrieve registry access details for an image

```
USAGE
  $ cloudscripts images docker-access NAME [-f]

ARGUMENTS
  NAME  Name of the image

FLAGS
  -f, --force  Force retrieval of new credentials

DESCRIPTION
  Retrieve registry access details for an image
```

_See code: [src/commands/images/docker-access.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/images/docker-access.ts)_

## `cloudscripts images info NAME`

Display information about a specific image

```
USAGE
  $ cloudscripts images info NAME

ARGUMENTS
  NAME  Name of the image

DESCRIPTION
  Display information about a specific image
```

_See code: [src/commands/images/info.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/images/info.ts)_

## `cloudscripts images list`

List all images

```
USAGE
  $ cloudscripts images list

DESCRIPTION
  List all images
```

_See code: [src/commands/images/list.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/images/list.ts)_

## `cloudscripts login`

Log into the Cloud Script Service

```
USAGE
  $ cloudscripts login [-e <value>] [-p <value>] [-i] [-u <value>]

FLAGS
  -e, --endpoint=<value>  Endpoint hostname (e.g. customername.skytap-portal.com)
  -i, --password-stdin    Read password from stdin
  -p, --password=<value>  Password
  -u, --username=<value>  Username

DESCRIPTION
  Log into the Cloud Script Service
```

_See code: [src/commands/login.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/login.ts)_

## `cloudscripts logout`

Log out from the Cloud Script Service

```
USAGE
  $ cloudscripts logout

DESCRIPTION
  Log out from the Cloud Script Service
```

_See code: [src/commands/logout.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/logout.ts)_

## `cloudscripts new DESTINATION`

Create a new script (alias for `cloudscripts scripts new DESTINATION`)

```
USAGE
  $ cloudscripts new DESTINATION -t <value>

ARGUMENTS
  DESTINATION  Destination

FLAGS
  -t, --template=<value>  (required) Template name

DESCRIPTION
  Create a new script (alias for `cloudscripts scripts new DESTINATION`)
```

_See code: [src/commands/new.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/new.ts)_

## `cloudscripts push SRC-PATH`

Push a script (alias for `cloudscripts scripts push SRC-PATH`)

```
USAGE
  $ cloudscripts push SRC-PATH [-f] [-n <value>]

ARGUMENTS
  SRC-PATH  Source path

FLAGS
  -f, --force         Force push
  -n, --name=<value>  Script name (defaults to directory name)

DESCRIPTION
  Push a script (alias for `cloudscripts scripts push SRC-PATH`)
```

_See code: [src/commands/push.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/push.ts)_

## `cloudscripts run SRC-PATH`

Run a script (alias for `cloudscripts scripts run SRC-PATH`)

```
USAGE
  $ cloudscripts run SRC-PATH [-n] [-r <value>]

ARGUMENTS
  SRC-PATH  Source path

FLAGS
  -n, --no-cache          Disable build artifact caching
  -r, --run-spec=<value>  Run spec to use for execution

DESCRIPTION
  Run a script (alias for `cloudscripts scripts run SRC-PATH`)
```

_See code: [src/commands/run.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/run.ts)_

## `cloudscripts scripts build SRC-PATH`

Build a script

```
USAGE
  $ cloudscripts scripts build SRC-PATH

ARGUMENTS
  SRC-PATH  Source path

DESCRIPTION
  Build a script
```

_See code: [src/commands/scripts/build.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/scripts/build.ts)_

## `cloudscripts scripts destroy NAME`

Deletes a script

```
USAGE
  $ cloudscripts scripts destroy NAME

ARGUMENTS
  NAME  Name of the script to remove

DESCRIPTION
  Deletes a script
```

_See code: [src/commands/scripts/destroy.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/scripts/destroy.ts)_

## `cloudscripts scripts info NAME`

Display information about a specific script

```
USAGE
  $ cloudscripts scripts info NAME

ARGUMENTS
  NAME  Name of the script

DESCRIPTION
  Display information about a specific script
```

_See code: [src/commands/scripts/info.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/scripts/info.ts)_

## `cloudscripts scripts list`

List all scripts

```
USAGE
  $ cloudscripts scripts list

DESCRIPTION
  List all scripts
```

_See code: [src/commands/scripts/list.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/scripts/list.ts)_

## `cloudscripts scripts new DESTINATION`

Create a new script

```
USAGE
  $ cloudscripts scripts new DESTINATION -t <value>

ARGUMENTS
  DESTINATION  Destination

FLAGS
  -t, --template=<value>  (required) Template name

DESCRIPTION
  Create a new script
```

_See code: [src/commands/scripts/new.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/scripts/new.ts)_

## `cloudscripts scripts package SRC-PATH`

Package a script to a local .tgz file

```
USAGE
  $ cloudscripts scripts package SRC-PATH -d <value>

ARGUMENTS
  SRC-PATH  Source path

FLAGS
  -d, --destination=<value>  (required) Destination path for the package file

DESCRIPTION
  Package a script to a local .tgz file
```

_See code: [src/commands/scripts/package.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/scripts/package.ts)_

## `cloudscripts scripts pull NAME`

Pulls a remote script

```
USAGE
  $ cloudscripts scripts pull NAME [-d <value>]

ARGUMENTS
  NAME  Name of the script to pull

FLAGS
  -d, --destination=<value>  Destination path

DESCRIPTION
  Pulls a remote script
```

_See code: [src/commands/scripts/pull.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/scripts/pull.ts)_

## `cloudscripts scripts push SRC-PATH`

Push a script

```
USAGE
  $ cloudscripts scripts push SRC-PATH [-f] [-n <value>]

ARGUMENTS
  SRC-PATH  Source path

FLAGS
  -f, --force         Force push
  -n, --name=<value>  Script name (defaults to directory name)

DESCRIPTION
  Push a script
```

_See code: [src/commands/scripts/push.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/scripts/push.ts)_

## `cloudscripts scripts run SRC-PATH`

Run a script

```
USAGE
  $ cloudscripts scripts run SRC-PATH [-n] [-r <value>]

ARGUMENTS
  SRC-PATH  Source path

FLAGS
  -n, --no-cache          Disable build artifact caching
  -r, --run-spec=<value>  Run spec to use for execution

DESCRIPTION
  Run a script
```

_See code: [src/commands/scripts/run.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/scripts/run.ts)_

## `cloudscripts templates list`

List available Cloud Scripts templates

```
USAGE
  $ cloudscripts templates list

DESCRIPTION
  List available Cloud Scripts templates
```

_See code: [src/commands/templates/list.ts](https://github.com/skytap/skytapcs-cli/blob/v0.1.67/src/commands/templates/list.ts)_
<!-- commandsstop -->
