creating-deploying-the-application-using-cli.md

AdminJS Cloud CLI for creating and deploying the application

AdminJS Cloud Hosting comes with a CLI tool which you can use locally or inside your CI/CD to deploy your application.

Requierments

Before you will make installation and configuration steps make sure you met all the requirements below.

• Node.js >=18 (we recommend latest LTS version)
• yarn installed globally (npm install --global yarn)

Installation

{% code overflow="wrap" %}

$ yarn global add @adminjs/cloud-cli

{% endcode %}

Configuration

@adminjs/cloud-cli relies on configuration file to be present in your source code. The default file name is adminjs-cloud.json but you can provide a custom file path using --config option in a CLI command.

Options

include        string[]        A list of files/directories you wish to deploy.

Example

{% code title="adminjs-cloud.json" %}

{
  "include": [
    "public",
    "dist",
    "src",
    ".env",
    "package.json",
    "tsconfig.json",
    "yarn.lock"
  ]
}

{% endcode %}

Starting the application

Currently, AdminJS Cloud Hosting requires start script to be present in your package.json file. This is the command you use to start your application:

{% code title="package.json" %}

{
  ...,
  "scripts": {
    ...,
    "start": "node app.js"
  }
}

{% endcode %}

In the future, we plan to extend application's configuration so that you can provide a custom start command.

Commands

As of version 1.2.0 the CLI only allows you to create and deploy your application.

To use @adminjs/cloud-cli you must first request an application in Pricing page and generate an API Key & API Secret.

#create

The create command allows you to create basic AdminJS application with basic authentication. The CLI generates only code for running it, you have to use commands yarn && yarn build && yarn start to check if setup is complete succesfully, if you follow all the steps correctly.

Parameters

name          string        required        The name of your application
database      string        required        The connection string to database eg. `postgres://adminjs:adminjs@localhost:5432/adminjs`
apiKey        string        required        Your API Key
apiSecret     string        required        Your API Secret
config        string        optional        Path to your configuration file (relative to PWD)

Usage

$ adminjs-cloud create --name=<string> --database=<string> --apiKey=<string> --apiSecret=<string>

#deploy

The deploy command allows you to deploy your source code. The CLI assumes your code is already built and whatever files you choose to include in your configuration file are enough to start your application.

Parameters

apiKey        string        required        Your API Key
apiSecret     string        required        Your API Secret
config        string        optional        Path to your configuration file (relative to PWD)

Usage

$ adminjs-cloud deploy --apiKey=<string> --apiSecret=<string> --config=[string]