@staticdeploy/cli

    0.15.4 • Public • Published

    @staticdeploy/cli

    CLI tool to create and deploy bundles.

    Install

    npm i -g @staticdeploy/cli

    Use

    • staticdeploy bundle: creates a bundle and uploads it to the StaticDeploy server. Options:

      • --config (optional): specify the file from which to load options. Defaults to staticdeploy.config.js
      • --apiUrl: URL of the StaticDeploy management API
      • --apiToken: authentication token for the management API
      • --from: path of the directory to create the bundle from
      • --name: name of the bundle
      • --tag: tag of the bundle
      • --description: description of the bundle
      • --fallbackAssetPath (optional): absolute path (relative to the from directory) of the asset to use as fallback when requests don't match any other asset. Defaults to /index.html, but the asset MUST exist
      • --fallbackStatusCode (optional): status code to use when serving the fallback asset. Defaults to 200
      • --headers (optional): (asset matcher, headers) map specifying which headers to assign to which assets
    • staticdeploy deploy: deploys a bundle to an entrypoint. Options (all required):

      • --config (optional): specify the file from which to load options. Defaults to staticdeploy.config.js
      • --apiUrl: URL of the StaticDeploy API
      • --apiToken: authentication token for the API
      • --bundle: name:tag combination of the bundle to deploy
      • --entrypoint: urlMatcher of the entrypoint to deploy to
      • --app: name of the app the entrypoint links to

    A valid config file has the following structure:

    module.exports = {
      // Optional
      bundle: {
        // Options for the bundle command as specified above
      },
      // Optional
      deploy: {
        // Options for the deploy command as specified above
      }
    };

    Options can also be passed as upper-cased, snake-cased, environment variables prefixed by STATICDEPLOY_. Eg:

    export STATICDEPLOY_API_URL=...
    export STATICDEPLOY_API_TOKEN=...

    Option sources have the following priority:

    1. command line flags
    2. environment variables
    3. configuration defined in the config file

    Meaning for example that when an option is provided both as a command line flag and as an environment variable, the value provided with the command line flag is used.

    Keywords

    none

    Install

    npm i @staticdeploy/cli

    DownloadsWeekly Downloads

    118

    Version

    0.15.4

    License

    MIT

    Unpacked Size

    24.5 kB

    Total Files

    18

    Last publish

    Collaborators

    • staticdeploy-npm-bot
    • pscanf
    • davidebianchi