Home
Reference
Review reference information for HCL® AppScan® Source, including using utilities, plug-ins, and APIs.
AppScan® Source command line interface (CLI)
The CLI is an interface to core AppScan® Source functionality.
AppScan® Source command line interface (CLI) commands
register (reg)

Welcome
Welcome to the documentation for HCL® AppScan® Source.
What's New
Explore new features added to AppScan® Source and note any features and capabilities deprecated in this release.
Installing
Learn how to install, upgrade, and activate HCL® AppScan® Source.
Configuring
Learn how to configure applications, folders, and projects, and set attributes and properties in HCL® AppScan® Source.
Administering
Learn how to administer user accounts and permissions, audit user activity, and manage integrations in HCL® AppScan® Source.
Scanning
This section explains how to scan your source code and manage assessments in HCL® AppScan® Source.
Triage and analysis
Grouping similar findings allows security analysts or IT auditors to segment and triage source code problems. This section explains how to triage AppScan® Source assessments and analyze results.
Reporting
Security analysts and risk managers can access reports of select findings or a series of audit reports that measure compliance with software security best practices and regulatory requirements. This section explains how to create reports of aggregate finding data.
Extending product function
Learn how to extend the product to meet specific development requirements.
Reference
Review reference information for HCL® AppScan® Source, including using utilities, plug-ins, and APIs.
- The Ounce/Make build utility
  Ounce/Make is a tool that automates the importing of configuration information into AppScan® Source from build environments that use makefile. Ounce/Make eliminates the need to import configuration information from makefiles manually; this the recommended method of configuring these projects.
- AppScan® Source command line interface (CLI)
  The CLI is an interface to core AppScan® Source functionality.
  - Objects and context
  - AppScan® Source command line interface (CLI) permissions
    Many CLI commands require that you have the appropriate AppScan® Source permissions.
  - Starting the AppScan® Source command line interface (CLI)
  - Command syntax
    AppScan® Source command line interface (CLI) commands conform to a usage template with required and optional arguments, similar to a command shell. CLI commands are not case sensitive and do not require switches for different arguments.
  - AppScan® Source command line interface (CLI) commands
    - AppScan® Source command line interface (CLI) command summary
    - about (a)
    - appscandelta (delta)
    - clearcache (cc)
    - delete (del)
    - deleteassess (da)
    - deleteuser (du)
    - delvar (dv)
    - details (det)
    - echo
    - export (expt)
    - getaseinfo (gase)
    - help (?)
    - import (im)
    - info (i)
    - list (ls, dir)
    - listassess (la)
    - listgroups (lgrp)
    - listusers (lu)
    - log
    - login (in)
    - login_file
    - login_local (local)
    - logout (out)
    - moduser (mu)
    - newuser (nu)
    - openapplication (oa)
    - openassessmentfile (oaf)
    - openfolder (of)
    - password (passwd)
    - printuser (pu)
    - publishassess (pa)
    - publishassessase (pase)
    - quit
    - record (rc)
    - refresh (rf)
    - register (reg)
    - removeassess (da)
    - report (rpt)
    - scan (sc)
    - script (scr)
    - setapplicationserver (sas)
    - setaseinfo (sase)
      If your AppScan® Enterprise Server has been installed with the AppScan Enterprise Console option, you can publish assessments to it. The Enterprise Console offers a variety of tools for working with your assessments, such as reporting features, issue management, trend analysis, and dashboards.
    - setcurrentobject (set, cd)
    - setexternaljdk (sej)
    - setvar (sv)
    - unregister (unreg)
  - Configuring a scan to run with the CLI
    You can use a configuration file to customize how a scan is run with the command line interface (using the scan command), wherein you can specify individual targets, or include or exclude targets. In addition, you can use the configuration file to specify additional information that would help to generate complete scan results.
  - Running automated assessments
    The AppScan® Source command line interface (CLI) enables you to automatically import an AppScan Source project file (.ppf) and scan your source code. From the command line, you can run a script, such as the following sample, Run_Assessments.txt.
- The Ounce/Ant build tool
  This section describes how to use Ounce/Ant, an AppScan® Source build utility that integrates AppScan Source and Apache Ant. Integrating Ounce/Ant with your Ant environment helps you automate builds and code assessments.
- AppScan® Source Data Access API
  The Data Access API provides access to AppScan® Source-generated assessment results, including findings and finding details. It also provides access to assessment metrics such as analysis date and time, lines of code, V-density, and number of findings.
- Glossary
  Learn common product terminology.
Troubleshooting and support
Self-help information, resources, and tools to help you troubleshoot issues while using HCL® AppScan® Source.

`register (reg)`

Description

Register allows you to register the application or project on the current node with AppScan® Source. Registration makes AppScan® Source aware of the applications and projects. Registered applications and projects can be published (using publishassess (pa)).

Once registered, you can also unregister applications or projects using

unregister
     (unreg)

Note: This command is not supported when AppScan® Enterprise Server is used as the datastore on AppScan® Source version 10.02 or later.

Syntax

register

Example

AllApplications>> cd pebble
AllApplications\pebble>> register
AllApplications\pebble>> ‘pebble' registered successfully.