divshot-cli

CLI for Divshot

npm install divshot-cli
20 downloads in the last day
223 downloads in the last week
1 287 downloads in the last month

Divshot CLI

CLI for Divshot

Commands

  • account - display basic account details
  • account:redeem - redeem a voucher and credit it to your account
  • apps - list your apps
  • auth:token - print out your access token
  • config - list, set, or remove keys and values from your app
  • config:add - add a value to the config file
  • config:remove - remove a value from the config file
  • create - create a new app
  • destroy - delete an app
  • domains - list your domains
  • domains:add - add a custom domain to your app
  • domains:remove - remove a custom domain from your app
  • help - get help with common commands
  • init - step by step guide to initiate an app in the current directory
  • login - login to Divshot
  • logout - logout from Divshot
  • open - open the current app in your default browser
  • promote - promote one environment to another
  • protect - add http basic auth to any environment
  • push - deploy your app to the specified environment
  • rename - change the name of an app
  • rollback - rollback an environment to a previous release
  • server - start server for local dev
  • status - show release info for each environment

Command Options

  • -h, --help - show the help menu
  • -v, --version - show current version of Divshot CLI
  • -t, --token [token] - manually pass access token
  • -a, --app [app name] - manually supply an app name

Environments

  • development - this is the default environment during app deployment
  • staging
  • production

Each environment is immediately available and deployed at the following URL scheme: http://[environment].[app name].divshot.io. You may reference Divshot Builds and Environments for a more detailed explanation.

Install

npm install divshot-cli -g

Commands

account

divshot account

Display your basic account details.

account:redeem

divshot account:redeem [voucher code]

Redeem a voucher and credit it to your account.

apps

divshot apps

List your Divshot apps.

auth:token

divshot auth:token

Print out your access token. This token is used to authenticate you with the Divshot API.

config

divshot config

List the keys and values from your Divshot app config file. See Divshot configuration reference for more details on these values.

config:add

divshot config:add [key] [value]

Add a value to your Divshot app config file. See Divshot configuration reference for more details on these values.

config:remove

divshot config:remove [key]

Remove a value from your Divshot app config file. See Divshot configuration reference for more details on these values.

create

divshot create [app name]

Create a new Divshot app. If no app name is provided, it attempts to read from your Divshot configuration file. It that does not exist, it will prompt you for an app name. You can easily create a new Divshot app locally and remotely by using divshot init.

destroy

dishot destroy [app name]

Delete a Divshot app. This is permanent and immediate. It removes not only your files, but it disables the subdomain associated with the application.

domains

divshot domains

See a list of all custom domains associated with your app. For more in-depth usage, see Divshot Custom Domains.

domains:add

divshot domains:add [domain]

Add a custom domain to your app. You may see a list of your domains with divshot domains. For more in-depth usage, see Divshot Custom Domains.

domains:remove

divshot domains:remove [domain]

Remove a custom domain from your app. You may see a list of your domains with divshot domains. For more in-depth usage, see Divshot Custom Domains.

help

divshot help

Get help with common Divshot commands. Lists all the available commands.

If you need help with a specific command, you may specify that command after the word help.

divshot help [command]

init

divshot init

Step by step guide to initiate an app in the current directory. The steps you are taken through are as follows:

  1. name - app name
  2. root - the root directory of the app relative to the current directory
  3. error page - the relative path or absolute url of an error/not foud page to display in in your app.
  4. create app - do you want to create new app on Divshot upon completing these steps? (As opposed to only creating the app locally)

Once you initiated your app, the root directory will now contain a divshot.json file with your settings. You may reference Divshot configuration reference for a more detailed description of this file.

login

divshot login

Login to your Divshot account.

logout

divshot logout

Logout of your account.

open

divshot open [optional environment]

Open app in your default browser.

Example:

  • divshot open - Opens the production, CDN environment of your app
  • divshot open development - Opens up the development environment of your app

promote

divshot promote [from env] [to env]

Promote one environment to another. A typical use case for this command would be to deploy your staging app to production without having to redeploy all the files. See environments for a list of available environments.

Example promotions

  • divshot promote development staging - development -> staging
  • divshot promote staging production - staging -> production

protect

divshot protect [environment] [username:password]

Protect your development and staging environments with http authentication.

push

divshot push [environment]

Deploy your app to the specified environment. If no environment is given, we assume that you mean production. The entire push process takes as long as the number of files in your project. Once deployed, your app is immediately available. See environments for a list of available environments.

rename

divshot rename [new app name]

Rename your app. This changes the subomdain on Divshot and updates your configuration file. It is permanent once complete.

rollback

divshot rollback [environment]

Rollback the given environment to a previous release. This is useful when buggy code has been deployed. Divshot automatically detects and rolls back to your previous release. See environments for a list of available environments.

server

divshot server

Start a server for local development. This local server mimics the capabilities of static sites running on Divshot. Refer to the Divshot documentation for configuration instructions.

Server command options:

  • -p, --port [port] - specify the port for the server to run. Defaults to 3474
  • -h, --host [hostname] - specify a custom hostname for your app to run at. Defaults to localhost

status

divshot status [environment]

Show release info for each environment. If no environment is specified, the latest release info will be listed for each environment. If an environment is specified, it will list the last few releases for that environment. See environments for a list of available environments.

npm loves you