Skip to main content

Apexlang CLI

The apex CLI is a one-stop shop for all projects across all languages.

It’s a

  • Project templating and scaffolding tool
  • Extensible code generation tool
  • Task runner

For more information, visit https://apexlang.io.

Prerequisites

The apex CLI depends on Deno.

Install deno with instructions here.

Installation

To install a release version of the apex CLI, run the command below:

deno install -A --unstable -f -n apex https://deno.land/x/apex_cli@v0.0.18/apex.ts

To install from source, clone this repository and run ./apex run install

git clone https://github.com/apexlang/apex.git
cd apex
./apex install # or deno install -A --unstable ./apex.ts

Usage

Visit https://apexlang.io for official documentation and usage.

apex --help

Output:

  Usage:   apex                                                                                           
  Version: v0.0.18  

  Description:

    A complete project tool suite based on Apexlang, an interface definition language (IDL) for modeling software.

  Options:

    -h, --help     - Show this help.                            
    -V, --version  - Show the version number for this program.  

  Commands:

    install      <location>          - Install templates locally.                                  
    new          <template> <dir>    - Create a new project directory using a template.            
    init         <template>          - Initialize a project using a template.                      
    generate     [configuration...]  - Run Apexlang generators from a given configuration.         
    list                             - List available resources.                                   
    describe                         - Describe available resources.                               
    watch        [configuration...]  - Watch configuration for changes and trigger code generation.
    run          [tasks...]          - Run tasks.                                                  
    upgrade                          - Upgrade apex executable to latest or given version.         
    help         [command]           - Show this help or the help of a sub-command.                
    completions                      - Generate shell completions.

Running tests

To run tests, run the command below:

apex test

Development

To run the development version of the apex CLI, use the apex script in the root of this repository, e.g.

./apex help

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details