deployed-cli

the deployed cli config file. Documentation: https://hyhello.github.io/deployed

Type object
File match .deployedrc .deployed.json .deployed.yaml .deployed.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/deployed-cli/latest.json
Source https://www.schemastore.org/deployed.json

Validate with Lintel

npx @lintel/lintel check
Type: object

JSON schema for the deployed cli config file.

See also: https://hyhello.github.io/deployed

Properties

projectName string required

Name of project to be released.

minLength=1
modeList object[] required
minItems=1uniqueItems=true
$schema string

JSON Schema for deployed.

minLength=1
cluster string[]

Alias collection of environment to be deployed.

uniqueItems=true
privateKey string | object

Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format).

passphrase string

For an encrypted privateKey, this is the passphrase used to decrypt it.

minLength=1
script string

Execute script commands.

minLength=1
backupName string

Old version backup name.

minLength=1
removeLocalDir boolean

Delete localpath after deployment.

clearRemoteDir boolean

Empty the old version before deploying the new version.

plugin string | array[]

List of plugins to load and use.

uniqueItems=true

Definitions

privateKey string | object

Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format).

passphrase string

For an encrypted privateKey, this is the passphrase used to decrypt it.

script string

Execute script commands.

backupName string

Old version backup name.

removeLocalDir boolean

Delete localpath after deployment.

clearRemoteDir boolean

Empty the old version before deploying the new version.