dcloud

DEITY Falcon Cloud CLI tool

dcloud is a tool to control, monitor and trigger your deployments to DEITY Falcon Cloud.

In order to use it, install it globally with:

npm i -g dcloud

Changelog

0.11.0

• Added DPSG commands - details here

0.10.0

• Added logs filtering (by application name) - details here
• Added logs stream filtering (by application name) - details here
• Added CDN purge command - details here
• Added CDN purge status progress command - details here
• Updated internal dependencies to improve security
• Added possibility to select version of FalconPlatform for particular environment - details here

0.9.0

• Added logs filtering (by date range, and severity) - details here
• Added log output formatting - it's now possible to print log entries as JSON - details here
• Added possibility to fetch single log item by its id - details here

Available commands:

Build List

List your current builds.

dcloud build:list

Options

• -l <limit> Limit the results
• -p <page> Which page of results to show

Example: show 30 results

dcloud build:list -l 30

---

Build Info

Get information on a build.

dcloud build [id]

Options

• -w Watch a build (if it's not finished)
• -o Show build output to the console

Example: Watch the build with id 20

dcloud build 20 -w

---

Deployment List

List your deployments

dcloud deployment:list

Options

• -l <limit> Limit the results
• -p <page> Which page of results to show

---

Deployment Info

Get information on a deployment.

dcloud deployment [id]

Options

• -w Watch a deployment (if it's not finished)
• -o Show deployment output to the console

---

Deploy

Deploy a build

dcloud deployment:run [buildId] [environmentName]

Options

• -y Auto-confirm the deployment process. Useful if you're not deploying manually.

Example: Deploy build 20 to the development environment

dcloud deployment:run 20 development

---

Environments List

List all available environments

dcloud env:list

Options

N/A

---

Environment Info

Get info on a specific environment

dcloud env <env>

Options

N/A

---

Environment Deployments

Get deployments for an environment

dcloud env:deployments <env>

Options

• -l <limit> Limit the results
• -p <page> Which page of results to show

---

Environment Variable

Set a variable on an environment (this doesn't send the variable to the application immediately. In order to do so you have to either run a deployment or apply saved variables)

dcloud env:var:set <env> <name> [value]

Options

• -s, --secret marks variable as secret - it's full value cannot be read (will be masked when displaying)

NOTE: to be sure that the values are correctly read from your terminal surround variable-value with double quotes, for example:

dcloud project:var:set BUILD_TOKEN "abcdefg123"

---

Apply environment variables

Applies previously set environment variables to the actual environment. Once applied the application in that environment will be restarted and after restart will have access to the applied environment variables.

dcloud env:var:apply <env>

Options

N/A

---

Environment Set Domain

Set the domain for an environment

dcloud env:domain:set <env> [domainName]

Options

N/A

---

View Environment domain configuration

Get the configuration of the domain assigned to the environment

dcloud env:domain <env>

Options

N/A

---

Environment Remove Domain

Remove the domain from an environment

dcloud env:domain:remove <env>

Options

N/A

---

Available FalconPlatform versions

List available FalconPlatform versions

dcloud env:platform-version:list

Set FalconPlatform version

Change FalconPlatform version for environment (deploy FalconServer in selected version to selected environment)

dcloud env:platform-version:set <env> <version>

Environment Purge CDN cache

Purge CDN cache for a domain

dcloud domain:purge-cdn-cache <env>

Options

N/A

---

Environment Purge CDN status progress

Get status of purge CDN process for a domain

dcloud domain:purge-cdn-status <purgeID>

Options

N/A

---

View environment logs

Get the list of latest logs per environment

dcloud log:list [options] [environment]

Options

• -l <limit> Limit the results

• -p <page> Which page of results to show

• --from <date> Date from (see below)

• --to <date> Date to (see below)

• --span <span> Date span (see below)

• -–severity <severity> Log item severity, (you join them with comma to use multiple at once). Available values: TRACE, DEBUG, INFO, WARNING, ERROR, CRITICAL

• -–app <value> Log item application name, (you join them with comma to use multiple at once). Available values: nginx, FalconServer, FalconClient

• -o, --output <format> Output format of the logs, by default it uses table so the logs are printed in the formatted table but you can also use json or json-formatted to get the items in JSON format

Date formats

You can use one of the following:

• ISO date format, e.g. 2021-02-01T11:31:17.003Z

• YYYY/MM/DD or YYYY-MM-DD, e.g. 2021/02/01 or 2021/02/01

• YYYY/MM/DD HH:MM:SS(Z) e.g. 2021/02/01 11:31:17 or 2021/02/01 11:31:17Z

Date span options

Date span option allows you to get log items from particular time span. You can combine that also with --from or --to to get the logs from exact time you're interested in

Available span markers:

• d - days

• h - hours

• m - minutes

• s - seconds

Examples:

• get logs from last 5 minutes: --span=5m

• get logs from 3 minutes before 2021/02/01 10:05:00 (up to 2021/02/01 10:05:00): --to='2021/02/01 10:05:00' --span=3m

• get logs from 2021/02/01 10:05:00 to 2 minutes after that time: --from='2021/02/01 10:05:00' --span=2m

---

Get log entry by id

Get log entry by its id

dcloud log:item [environment] [itemId]

Options

• -o, --output <format> Output format of the logs, by default it uses table so the logs are printed in the formatted table but you can also use json or json-formatted to get the items in JSON format

---

Stream the latest logs for an environment

Get the log output for given environment

dcloud log:watch [environment]

Options

• -–severity <severity> Log item severity, (you join them with comma to use multiple at once). Available values: TRACE, DEBUG, INFO, WARNING, ERROR, CRITICAL

• -–app <value> Log item application name, (you join them with comma to use multiple at once). Available values: nginx, FalconServer, FalconClient

---

Repositories List

Get a list of your current/active repositories

dcloud repo

Options

• -i Show setup instructions for each repository

---

Project Info

Get your project information

dcloud project <name>

Options

N/A

---

Projects List

Get a list of your projects

dcloud project:list

Options

N/A

---

Project Current

Get the current project

dcloud project:current

Options

N/A

---

Project Set Current

Set a project as current

dcloud project:current:set <name>

Options

N/A

---

Project Build Variables List

List your variables

dcloud project:var:list

Options

N/A

NOTE: variables listed here for security reasons are masked and you cannot read the exact value

---

Set Project Build Variable

List your variables

dcloud project:var:set <variable-name> <variable-value>

Options

N/A

NOTE: to be sure that the values are correctly read from your terminal surround variable-value with double quotes, for example:

dcloud project:var:set BUILD_TOKEN "abcdefg123"

---

Login

WARNING: This is deprecated, please use Login with Token to log in. Existing users will be prompted to migrate to using a token for logging in.

Logs into DEITY Falcon Cloud using credentials. If credentials aren't passed you will be prompted to add them.

dcloud login [email] [password]

Options

N/A

---

Logout

Logs the current user out

dcloud logout

Options

N/A

---

Who am I

Get the current logged in user

dcloud whoami

Options

N/A

DPSG

List of all available Payment Providers

dcloud payments:provider:list:all

List of all available Payment Methods (per provider)

dcloud payments:method:list:all

List configured Payment Providers per environment

dcloud payments:provider:list

List configured Payment Methods per environment

dcloud payments:method:list

Configure Payment Provider (wizard)

dcloud payments:provider:configure

Configure Payment Method (wizard)

dcloud payments:method:configure

Create a payment environment (profile)

dcloud payments:env:create

Get environment info (including tokens)

dcloud payments:env:info