jec-cli/config/jec-config.json

CLI tool for managing JEC projects.

[
  {
    "command": "help",
    "alias": "h",
    "description": "Provides help information for jec commands.",
    "signature": "[command]"
  },
  {
    "command": "version",
    "alias": "v",
    "action": "jec/version",
    "description": "Gets the current JEC CLI version."
  },
  {
    "command": "glasscat-version",
    "alias": "gv",
    "action": "jec/glasscat-version",
    "description": "Gets the default GlassCat version used to install GlassCat servers."
  },
  {
    "command": "glasscat-install",
    "alias": "gi",
    "action": "jec/glasscat-install",
    "description": "Installs a new a GlassCat server in the current directory.",
    "signature": "[--version] [--env]",
    "options": [
      {
        "name": "env",
        "description": "Defines which setup to use for the server environment."
      },
      {
        "name": "version",
        "description": "Defines a specific version of the GlassCat server to install."
      }
    ]
  },
  {
    "command": "create-bootstrap",
    "action": "jec/create-bootstrap",
    "description": "Creates a new a JEC bootstrap class.",
    "signature": "--name [--index] [--disabled]",
    "options": [
      {
        "name": "name",
        "required": true,
        "description": "The name of the bootstrap class."
      },
      {
        "name": "index",
        "description": "Specifies the position of the bootstrap class instance in the bootstrap files execution queue."
      },
      {
        "name": "disabled",
        "description": "Indicates wheter the bootstrap class instance is ignored at the server start (true), or not (false)."
      }
    ]
  },
  {
    "command": "create-jslet",
    "action": "jec/create-jslet",
    "description": "Creates a new a JEC jslet class.",
    "signature": "--name --urlPatterns [--template]",
    "options": [
      {
        "name": "name",
        "required": true,
        "description": "The name of the jslet class."
      },
      {
        "name": "urlPatterns",
        "required": true,
        "description": "The patterns associated with the jslet to specify URL mapping."
      },
      {
        "name": "template",
        "description": "The template file associated with this jslet."
      }
    ]
  },
  {
    "command": "create-interface",
    "action": "jec/create-interface",
    "description": "Creates a new a JEC interface.",
    "signature": "--name [--pkg]",
    "options": [
      {
        "name": "name",
        "required": true,
        "description": "The name of the interface."
      },
      {
        "name": "pkg",
        "description": "The name of the package for this interface."
      }
    ]
  },
  {
    "command": "create-test-suite",
    "alias": null,
    "action": "jec/create-test-suite",
    "description": "Creates a JUTA test suite for the specified class",
    "signature": "--class",
    "options": [
      {
        "name": "class",
        "description": "Indicates the class for which to create the test suite."
      }
    ]
  },
  {
    "command": "create-resource",
    "action": "jec/create-resource",
    "description": "Creates a new a JARS resource class.",
    "signature": "--name --path [--rootPathRefs]",
    "options": [
      {
        "name": "name",
        "required": true,
        "description": "The name of the resource class."
      },
      {
        "name": "path",
        "required": true,
        "description": "The path used to declare the resource."
      },
      {
        "name": "rootPathRefs",
        "description": "The list of references that specify all enable versions of the resource."
      }
    ]
  },
  {
    "command": "create-root-path",
    "action": "jec/create-root-path",
    "description": "Creates a new a JARS root path.",
    "signature": "--name --ref --path [--prefix] [--major] [--minor]",
    "options": [
      {
        "name": "name",
        "required": true,
        "description": "The name of the root path."
      },
      {
        "name": "ref",
        "required": true,
        "description": "The reference used to identify the root path."
      },
      {
        "name": "path",
        "required": true,
        "description": "The path used to define a specific versioned route."
      },
      {
        "name": "prefix",
        "description": "The prefix used to define a unique versioned route. Default value is 'v'."
      },
      {
        "name": "major",
        "description": "The major version number used to define a unique versioned route. Default value is '1'."
      },
      {
        "name": "minor",
        "description": "The major minor number used to define a unique versioned route. Default value is '0'."
      }
    ]
  }
]