Scan

The command help is shown below.

Usage: qaskx-cli rediops scan [-d=<devops file path>] [-p=<project folder>] [-o=<output file>] [-f=<format>] [--overwrite] [-v | --vv | --vvv | --silent] [-c=<conf file>] [--colourCLI] [--offline] [--env=<environment file>]

The rediOps scan command searches the project folders for well
known files as specified in the configuration file.  The resulting
list of files and their assumed types is then used to update the
rediOps details in the devops.json file.
			
Optionally the command can output the scan (search) results to
the console or an output file.

For more details see the documentation at https://docs.qaskx.one/qaskx-cli/cmd/rediops//scan/ .
                    
Options:            
  -d, --devops      rediOps (devops.json) file path
  -p, --parent      Parent (or root) directory for scan (default "./")
  -o, --output      Output file name
  -f, --format      Output format (default "CONSOLE")
      --overwrite   Overwrite existing content
  -v, --verbose     Verbose logging
      --vv          Verbose logging level 3
      --vvv         Verbose logging level 5
      --silent      Silent running
      --colourCLI   Colour terminal and command line (env $QASKX_COLOUR_CLI)
  -c, --conf        Configuration file (env $QASKX_CONFIG_FILE)
      --offline     Offline mode (env $QASKX_OFFLINE)
      --env         Environment file to use (default ".env")

Details

The scan feature is intended to locate well known artefacts for devops activity.

The artefacts include:

  • OpenAPI files
  • AsyncAPI files
  • Pipeline files
  • Infrastructure as Code files
  • Ansible playbooks

Once artefacts are identified they can be added to the rediOps file.

This feature is still under active development.