skip to Main Content

Install

  1. Go to https://apexcl.dev/download/ and download the APEXcl installer for your operating system
  2. Run the installer and follow the installation steps
  3. Open a terminal and type apexcl
    quickstart-alias
    Make sure you see the following interface
    quickstart-apexcl

Usage

You can use APEXcl in two different ways: a Cloud service and an On-prem service. Read about the best service for you here.

Here’s how to use those two services.

APEXcl Cloud

  1. Use the APEX Builder to download your application export
    quickstart-apex-export
  2. Note the path of your download file (example: ~/Downloads/f100.sql)
  3. Open a terminal and go to your APEX project directory where you want APEXcl to run (or create your APEX project directory if it doesn’t exist)
    quickstart-cd
  4. Type
    apexcl cloud -f ~/Downloads/f100.sql

    where ~/Downloads/f100.sql is a reference to your application export file from step 2
    quickstart-cloud

  5. Pick an APEXcl export mode
    quickstart-cloud-choose
  6. Wait for the process to complete
    quickstart-cloud-done
  7. Enjoy file-based APEX application
    quickstart-output
  8. Optionally integrate with version control systems **

APEXcl On-prem

  1. Open a terminal and go to your APEX project directory where you want APEXcl to run (or create your APEX project directory if it doesn’t exist)
    quickstart-cd
  2. Type apexcl init to configure how APEXcl will connect to your database (only do this step once)
  3. Type apexcl export to start the APEXcl extraction process
    quickstart-export
  4. The first time you run apexcl export, you will be prompted for a SYSDBA user. APEXcl needs to install a few objects in your database. Follow through the questions on your terminal.
  5. Pick an APEXcl export mode
    quickstart-export-choose
  6. Wait for the process to complete
    quickstart-export-done
  7. Enjoy file-based APEX application
    quickstart-output
  8. Optionally integrate with version control systems **

** Integrate with version control systems

APEXcl is best used in conjunction with a version control system like Git or SVN, because APEXcl splits your applications into hundreds of small files (one file per APEX component) which make it very convinient to use "diff" features from version control systems, allowing you to highlight with great precision what has changed in your application, when it has changed, and by who. Below is an example with Git.

If you haven’t initialized Git already:

  1. Download Git: https://git-scm.com/downloads
  2. On a command line, go to the directory where APEX has run.
  3. Initialize a new Git repository: git init

Periodically, run APEXcl and add the new files to Git:

  1. Run APEXcl (see Cloud or On-prem instructions above)
  2. See the changes you made to your application: git diff
  3. Add your files to Git: git add *
  4. Commit your files to Git: git commit -m "my APEX changes"
  5. Push your changes git push origin master

Or follow a simple Git guide, like this one: http://rogerdudler.github.io/git-guide/

Back To Top