Koolay CLI User Guide

           CLI (Command Line Interface) is a text-based interface that allows users to interact with software or the operating system by typing commands. Unlike a Graphical User Interface (GUI), CLI is lightweight and efficient, often preferred for tasks that require speed and precision. 

      Key Features of CLI: 

      1. Text-Based Interaction: Users input commands through a terminal or console. 
      2. Speed and Flexibility: Complex operations can be performed quickly. 
      3. Scripting and Automation: Ideal for creating scripts to automate repetitive tasks. 
      4. Low Resource Usage: CLI doesn’t rely on graphical elements, so it uses minimal system resources. 
      5. Enhanced Control: Provides more granular control over system operations. 

      Benefits of CLI in the Koolay System: 

      • Efficient Management: Enables quick system management and configuration. 
      • Data Analysis and Monitoring: Real-time system monitoring and data analysis commands can be integrated. 
      • Custom Scripting: Users can create custom scripts to automate frequent operations. 

       

      Download: 

      Mac:https://stkoolayeus001.blob.core.windows.net/cli/KoolayCLI.dmg

      Windows:https://stkoolayeus001.blob.core.windows.net/cli/KoolayCLI-x64-setup.msi

       

      KoolayCLI Setup 

      1. Open the installation file you downloaded. 
      2. Press the “Next” button in the installation that opens. 

           3. Select the location where you want to install the program and click “Next”. 

           4. Wait for the installation to complete. 

           5. Complete the installation by pressing the “Finish” button. 

      Koolay CLI Usage: 

      1. To access the Koolay CLI, open the command prompt (CMD) on your windows computer as administrator. 
      2. Type “koolaycli” at the command line. 

           3. This will give you access to the KoolayCLI system.

      Commands:  

      Login: 

      First of all, you must log in to the system using the login command. 

      Usage: koolaycli login (e-mail adress) (password) 

      When you have successfully logged in, it will look like the one below. 

      Get companies: 

      Use this command to see all companies/entities you own. 

      Usage: koolaycli get companies 

      Set company: 

      Using this command, you can select one of the companies/organizations you listed earlier. When selecting, you need to select Company Id. 

      Usage:  koolaycli set company (COMPANY ID) 

      Get sites: 

      You should use this command to select the site within one of the companies you have selected. 

      Usage: koolaycli get sites 

      Set site: 

      You can use this command to select the site you want to process from the sites you have listed. After typing the command, you must write the Site number at the end of the command. 

      Usage:koolaycliset site(site id) 

      Get domains: 

      You can see the domain addresses of the site you have selected with this command. 

      Usage: koolaycli get domains 

      Pull: 

      With this command, you can download all the files of the site you have selected to your computer. Select the location where you want to download with the -p command and then type the location of the file from which you want to download the files. 

      Usage: koolaycli pull –p (FILE LOCATİON) 

      Diff:  

      You can use this command to check the current status of the file you downloaded to your computer. This command usually shows which file has been modified. 

      Usage: koolaycli diff –p (FILE LOCATİON) 

      Push: 

      You can use this command to upload the files again with the changes made. 

      Usage: koolaycli push –p (FILE LOCATİON) 

      History: 

      You can use this command to see all the changes made. 

      Usage: koolaycli history (FILE LOCATİON)

      Revert: 

      You can use this command to return to a previous operation. After typing the command, type the Commit Hask code of the change you want to revert to in the history table. 

      Usage: koolaycli revert (COMMIT HASH CODE) -p (FILE LOCATİON) 

      - Use the “push” command again to upload the change. 

      Logout: 

      You must use this command to log out of the CLI. 

      Usage: koolaycli logout 

      Last updated on 2024-11-19 14:47:36Z by Koolay