Commands
After you have installed APEXcl, you will have access to the APEXcl commands on your terminal. Every command is used by typing the following format on your terminal: apexcl [command] [options]
.
This page describes all the possible commands you can use.
At any time during the execution of an APEXcl command, you can exit with ctrl + c
.
cloud
(This is exclusive to the APEXcl Cloud or free trial license)
You can use APEXcl in two different ways: a Cloud service and an On-prem service.
With our Cloud service, there is nothing to install in your database. APEXcl users provide the path to their application export file, which is then processed by our Cloud installation of APEXcl. The results of the processing are then sent back to the end user.
Usage: apexcl cloud [options]
Use the APEXcl Cloud service to get your files from an APEX application export file.
Options:
-f, --file <filePath> Path to your APEX application export file.
-o, --output <outputPath> Path where APEXcl will extract files.
-a, --app Export your entire APEX application.
-p, --page <pageId> Export page <pageId> of your APEX application.
-s, --sharedcomponents Export only the shared components.
-h, --help output usage information
Our Cloud service automatically cleans any bit of data you send to us once the process is over. We don’t keep anything.
init
(This is exclusive to the APEXcl On-prem or free trial license)
If you use APEXcl Cloud, you do not need to use the init
command.
If you use APEXcl On-prem, before you can make extract your files you first need to run the init
command to establish the connection between APEXcl, the Oracle database and your APEX application. This step should only be run once per APEX application.
You will be prompted with a series of questions, such as your application ID, database credentials, and a few APEXcl specific options (described below).
Usage: apexcl init [options]
Configure the settings for the 'apexcl export' command (see below).
Options:
-h, --help output usage information
After running the init command, a file named apexcl.config.json
will be created in the current directory of your terminal. The apexcl.config.json
looks like this:
{
"appId": "200",
"database": {
"user": "hr",
"password": "mypassword",
"connectString": "localhost:1521/XEPDB1"
},
"apexclSchema": "APEXCL",
"ignoreSequence": true,
"exportAppSql": false,
"includeAudit": false,
"includeStaticFiles": false
}
Property | Type | Required | Default | Description | Example |
---|---|---|---|---|---|
appId | string | Yes | The application ID of the APEX application to be exported | 100 | |
exportPath | string | No | (current command line directory) | Path where the application will be exported. Warning: when APEXcl exports an application, it erases the content of this folder and repopulates it. | ~/MyProject/apex |
database.user | string | Yes | The database user for the parsing schema of the APEX application | dev | |
database.password | password | Yes | The database password for the parsing schema of the APEX application | oracle | |
database.connectString | string | Yes | The database connection string for the parsing schema of the APEX application. For more info on Oracle connection strings, please read https://github.com/oracle/node-oracledb/blob/master/doc/api.md#-121-connection-strings | localhost:1521/orcl | |
apexclSchema | string | No | APEXCL | The database user on which APEXcl is installed APEXCL | |
ignoreSequence | boolean | No | true | Sequences in APEX change a LOT when you start adding and moving components (Region sequence, item sequence, etc.), and they don’t provide much value for code review. By default, APEXcl will ignore sequences, but you can turn that option off to include sequences in your APEXcl export files. |
export
(This is exclusive to the APEXcl On-prem or free trial license)
Use the export
command to start the extraction process of your APEX application, from your own database, to your file system. You can repeat this process many times during your development, such as:
- after a functionality is complete
- daily check-in
Usage: apexcl export [options]
Use APEXcl to export your application directly from your own database.
Options:
-a, --app Export an entire APEX application.
-p, --page <pageId> Export page <pageId> of an APEX application.
-s, --sharedcomponents Export only the shared components.
-h, --help output usage information
You can use the export
command in different ways. You have the choice to export:
- Your entire APEX application
- A specific page of your APEX application
- The shared components of your APEX application
By typing apexcl export
on your terminal, you will be asked which of the three options to pick. You can use the shortcuts to skip the interactive questions (e.g.apexcl export --app
or apexcl export --page 1
or apexcl export --sharedcomponents
).
login
After you have purchased an APEXcl license (Cloud, On-prem, or free trial), use the login
command to authenticate your account into your system. You only have to use the login
command once and you will be able to use APEXcl for as long as your subscription is valid.
USAGE
\$ apexcl login [options]
OPTIONS
-h, --help output usage information
EXAMPLES
$ apexcl login
$ apexcl login -h
logout
Logout from your APEXcl account. This will delete the license key on your computer. You can no longer use APEXcl after you have logged out, until you log in again with a valid account.
USAGE
\$ apexcl logout [options]
OPTIONS
-h, --help output usage information
EXAMPLES
$ apexcl logout
$ apexcl logout -h