Apps Engine CLI
The Rocket.Chat Apps Engine CLI is a simple command-line interface that facilitates the development of Rocket.Chat applications. This computer program allows you to create and delete files, execute programs, and navigate through folders and files. On a Mac, it is referred to as Terminal, whereas on Windows, it is Command Prompt. The Command Line is a potent application that will expand your programming capabilities.
Using straightforward commands, you can compile and deploy a basic app structure to your Rocket.Chat Server. We have enhanced its capacity to generate boilerplate code for various functions, display autocomplete installation instructions, submit an app for review in the marketplace, and more. The Rocket.Chat Apps Engine CLI enables you to create new applications and deploy them on your deployment environment, as well as package your application for shipping and future deployment on other installations.
Before installing the CLI, you must ensure that Node.js is already installed on your system. Use the following command in your terminal to verify the installation of Node.js:
node -v
# v10.15.3
# It should return you a valid version.
Run the following command in your terminal after installing Node.js to deploy the CLI globally.
npm install -g @rocket.chat/apps-cli
Troubleshooting Tip
Error: While attempting to execute the preceding command, if your operating system rejects the operation, it is likely that you do not have permission to access the file as the current user. If you suspect a permissions issue, please double-check your NPM installation, or rerun the command as root/Administrator.
Resolution: Prefix the command with sudo and execute as follows:
sudo npm install -g @rocket.chat/apps-cli
After executing this command, enter the system user's password. This will grant the application all necessary permissions, as this command must be executed as an administrator.rc-apps -v
# @rocket.chat/apps-cli/1.4.0 darwin-x64 node-v10.15.3
Depending on the speed of your Internet connection, CLI installation will take some time. After installation, run the following command to verify the installation. Note that the response may differ depending on your system and environment, but it should have a similar appearance.
Additionally, we recommend that you install Visual Studio Code. In addition, a local development instance of Rocket.Chat must be running on your system.
Open the terminal in Visual Studio and execute the following command:
npm install
This installs the Apps-Engine framework/library, allowing applications to recognize Apps-Engine.
You are now all set to develop your first app.
Last modified 11d ago