Catalyst

by Zoho
×
Cancel
  • Tutorials
  • FAQ
  • Developer Tools
    CLI
    SDK
    Java Node.js Python Web Android iOS Flutter
    REST API
    Utilities
    Extensions Tools Integrations
    • Go to console

    CodeLib Installation

    Install a CodeLib Solution from Catalyst CLI

    Before you install a CodeLib solution, you will need to install the Catalyst CLI and login to it. You will then be able to install a CodeLib solution from the CLI. All resources that are included in a specific CodeLib solution are auto-created and auto-configured, and the required code is added to your current project.

    If you are installing a CodeLib for an already existing Catalyst project, navigate to its root directory from your terminal and directly proceed with the installation.

    You can also initialize a new project by following the steps mentioned in this page. After you initialize the project, proceed to navigate to its root directory and continue with the installation.

    Note:

    • Certain CodeLib solutions might include prerequisites to be installed or configured for their functioning. You can open a specific CodeLib solution from your Catalyst console to check the details on its specific prerequisites and installation instructions. Click the CodeLib icon on the bottom right corner in your project and click on the required solution to open it.

    • Installing a CodeLib solution will automatically deploy all the pre-configured Catalyst resources from the CLI to the remote console for your current Catalyst project.


    The general steps to install a CodeLib solution from the CLI are given below.

    1. Execute the command below to install a Catalyst CodeLib solution:
    copy
    $
    catalyst codelib:install

    1. You will be prompted to choose the category of the CodeLib solution. Select Integration.

    2. You will be able to see the list of available Catalyst CodeLib solutions here. Select the required solution and press Enter.

    select_codelib_solution

    1. Upon selecting a solution to install, the CLI will display the list of Catalyst resources that are pre-configured as a part of that solution. Press Y and press Enter to confirm.

    install_codelib_solution

    The CodeLib solution will be installed in the directory, and the required resources will be configured and deployed to the remote console, along with the business logic.


    Install a CodeLib solution from the Git Repo

    You can also install a Catalyst CodeLib solution by directly accessing the Catalyst CodeLib repositories on GitHub. The README files in each of the CodeLib solution directories contain detailed information about the architecture and the flow of execution involved in that solution, along with the resources utilized.

    You can execute the CLI command given below in your terminal to install a specific CodeLib solution from this repository. You will need to mention the specific CodeLib package name in the command.

    copy
    $
    catalyst codelib:install https://github.com/catalystbyzoho/<<Enter codelib package name>>

    This will directly install the selected CodeLib solution.

    Last Updated 2023-07-31 16:50:25 +0530 +0530

    PREVIOUS

    NEXT