CLI for Divshot
- 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 a divshot.io 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 Divshot.io commands
- init - step by step guide to initiate an app in the current directory
- login - login to Divshot.io
- logout - logout from Divshot.io
- promote - promote one environment to another
- 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
- -v - show current version of Divshot Cli
--token [token]
- manually pass access token--app [app name]
- manually supply the Divshot.io app name--no-color
- strip all use of color in output
####Environments
development
staging
production
- this is the default environment during app deployment
Each environment is immediately available and deployent at the following url scheme: http://[environment].[app name].divshot.io. You may reference Divshot.io Builds and Environments for a more detailed explanation.
npm install divshot-cli -g
divshot apps
List your Divshot.io apps.
divshot auth:token
Print out your access token. This token is used to authenticate you with the Divshot api.
divshot config
List the keys and values from your Divshot.io app config file. See Divshot.io configuration reference for more details on these values.
divshot config:add [key] [value]
Add a value to your Divshot.io app config file. See Divshot.io configuration reference for more details on these values.
divshot config:remove [key]
Remove a value from your Divshot.io app config file. See Divshot.io configuration reference for more details on these values.
divshot create [app name]
Create a new Divshot.io app. If no app nam eis provided, it attempts to read from your Divshot.io configuration file. It that does not exist, it will prompt you for an app name. You can easily create a new Divshot.io app locally and remotely by using divshot init
.
dishot destroy [app name]
Delete a Divshot.io app. This is permanent and immediate. It removes not only your files, but it disables the subdomain associated with the application.
divshot domains
See a list of all custom domains associated with your app. For more in depth usage, see Divshot.io Custom Domains
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.io Custom Domains
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.io Custom Domains
divshot help
Get help with common Divshot.io 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]
divhshot init
Step by step guide to initiate an app in the current directory. The steps you are taken through are as follows:
name
- app nameroot
- the root directory of the app relative to the current directoryerror page
- the relative path or absolute url of an error/not foud page to display in in your app.create app
- do you want to create new app on Divshot.io upon completing these steps? (As opposed to only creating the app locally)
Once your initiated your app, the root directory will now contain a divshot.json
file with your settings. You may reference Divshot.io configuration reference for a more detailed description of this file.
divshot login
Login to your Divshot.io account.
divshot logout
Logout of your account.
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 reploy all the files. See environments for a list of available environments.
Example promotions
divshot promote development staging
- development -> stagingdivshot promote staging production
- staging -> production
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.
divshot rename [new app name]
Rename your app. This changes the subomdain on Divshot.io and updates your configuration file. It is permanent once complete.
divshot rollback [environment]
Rollback the given environment to a previous release. This is useful when buggy code has been deployed. Divshot.io automatically detects what your previously release was and rollsback to that release. See environments for a list of available environments.
divshot server
Start a server for local development. This local server mimics the capabilities of static sites running on Divshot.io. Refer to the Divshot.io 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
divshot status [environment]
Show release info for each environment. If you no environment is specified, the latest release info will be listed for each enviornment. If an environment is specifed, it will list the last few releases for that environment. See environments for a list of available environments.