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
log:watch command--module option to search logs module field details here--data-file, -d flag that gives the possibility to load the value of environment variable from a file so it doesn't stay in the bash history details here--base64, -e flag that encodes the value of passed environment variable as base64 before sending to the api details here--from-file, -f flag that gives the possibility to set multiple environment variables at once (by loading them from specified file) details herepayments:customer-map:add command for adding mappings between shop customer and psp customer details here--path option to purge cdn domain - details heredcloud env:cache:flush <env> that flushes the environment cache - details heredcloud project:current:set can now be executed without the organization and project flag. When doing so, you can select the project using an interactive prompt.payments:env commands to payments:profile.payments:region commands. This functionality is replaced by region prompts on most payments commands.payments:profile:sync.--phrase parameter to filter logs by passed search phrase.dcloud env commandMerchant's store country when configuring the Humm payment provider.List your current builds.
dcloud build:list
Options
-l <limit> Limit the results-p <page> Which page of results to showExample: show 30 results
dcloud build:list -l 30
Get information on a build.
dcloud build [id]
Options
-w Watch a build (if it's not finished)-o Show build output to the consoleExample: Watch the build with id 20
dcloud build 20 -w
List your deployments
dcloud deployment:list
Options
-l <limit> Limit the results-p <page> Which page of results to showGet information on a deployment.
dcloud deployment [id]
Options
-w Watch a deployment (if it's not finished)-o Show deployment output to the consoleDeploy 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
List all available environments
dcloud env:list
Options
N/A
Get info on a specific environment
dcloud env <env>
Options
N/A
Get deployments for an environment
dcloud env:deployments <env>
Options
-l <limit> Limit the results-p <page> Which page of results to showSet 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)-d, --data-file <filePath> Path to the file containing environment variable value-e, --base64 Encode the variable value as base64 string before sending it-f, --from-file <filePath> Set multiple environment variables from a file with one command (see information about file format below)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"
Format of the file passed to -f (--from-file) option is the following:
FOO=variable value
# comment - will be ignored
BAR=126
BAZ=full string will be taken as value
NOTE: Everything after first
=sign will be passed as variable value - including whitespaces, quotes etc. It means that if you put a string in quotes then these quotes will be included as value (which usually is not intended).
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
Assign a domain to an environment
dcloud env:domain:assign <env> [domainName]
Options
N/A
Get the configuration of the domain assigned to the environment
dcloud env:domain <env>
Options
N/A
Un-assign a domain from an environment
dcloud env:domain:unassign <env> [domainName]
Options
N/A
Upload redirects rules
dcloud env:redirects:upload <env> <absolute path to file>
CSV File format example:
old_url,new_url
old_url2,new_url2
old_url3,new_url3
Options
N/A
Delete redirects
dcloud env:redirects:delete <env>
Options
N/A
Flush environment cache
dcloud env:cache:flush <env>
Options
N/A
List available FalconPlatform versions
dcloud env:platform-version:list
Change FalconPlatform version for environment (deploy FalconServer in selected version to selected environment)
dcloud env:platform-version:set <env> <version>
List all the domains created in the project
dcloud domain:list
Creates domain (managed by DeityCloud infrastructure or externally) and its configuration but doesn't apply it to an environment, so the domain is not used yet.
You can create many domains in the scope of the project and then assign particular domain to particular environment.
dcloud domain:create <domain>
Options
--external marks domain as external - if you manage the domain by yourself (e.g. on your CloudFlare account then use this flag)dcloud domain:create --external my-custom-domain.com
Removes the domain from project. Please note that the domain must not be assigned to any environment in order to remove it.
dcloud domain:remove <domain>
Options
N/A
Purge CDN cache for a domain
dcloud domain:purge-cdn-cache <domain>
Options
-p, --path <path> Purges at CDN the particular path at your domain: example.com/YOUR_PATHdcloud domain:purge-cdn-cache example.io -p robot.txt
Get status of purge CDN process for a domain
dcloud domain:purge-cdn-status <purgeID>
Options
N/A
After cration of a domain under your project you need to validate its ownership in order to be able to assign the domain to an environment and create SSL certificate for it.
To start the vadliation run:
dcloud domain:validate <domain>
Options
N/A
The process will guide you through the validation of both domain ownership and SSL certificate. Once these steps are done you'll be able to assing the domain to your environment.
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
-–phrase <value> Log item filtered by passed search phrase.
-–module <value> Log item filtered by passed module.
-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
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 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 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 formatGet 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
-–phrase <value> Log item filtered by passed search phrase.
Get a list of your current/active repositories
dcloud repo
Options
-i Show setup instructions for each repositoryGet your project information
dcloud project <name>
Options
N/A
Get a list of your projects
dcloud project:list
Options
-l <limit> Limit the results-p <page> Which page of results to showGet the current project
dcloud project:current
Options
N/A
Set a project as current
dcloud project:current:set [organization] [projectName]
Options
N/A
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
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"
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
Logs the current user out
dcloud logout
Options
N/A
Get the current logged in user
dcloud whoami
Options
N/A
Create and send invitation
dcloud user:invite <email> <name>
Running this command will show you picker that gives the possibility to select a role which invited user will get assigned
Example: show 30 results
dcloud user:invite john@example.com "John Smith"
Options
N/A
dcloud payments:provider:list:all
dcloud payments:method:list:all
dcloud payments:provider:list
dcloud payments:method:list
dcloud payments:provider:configure
dcloud payments:method:configure
dcloud payments:profile:sync
dcloud payments:profile:create
dcloud payments:profile:update
dcloud payments:profile:delete
dcloud payments:profile:info
dcloud payments:customer-map:add --organization <my-org> --project <my-project> --environment <my-env> --provider <provider-name> --region <dpsg-region> <shopCustomerId> <pspCustomerId>
or to use a step-by-step wizard - run:
dcloud payments:customer-map:add
FAQs
DEITY Falcon Cloud CLI tool
The npm package dcloud receives a total of 26 weekly downloads. As such, dcloud popularity was classified as not popular.
We found that dcloud demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm confirmed a tooling bug incorrectly marked several one-character packages as security holders and said it was working on a rollback.
Research
/Security News
Newer packages in this compromise use native extensions and .pth loaders to execute JavaScript stealers in developer environments.
Research
Socket found 37 malicious PyPI wheels that abuse Python startup hooks to launch a Bun-powered credential stealer tied to Mini Shai-Hulud/Miasma.