Engine Command Line Interface

🚀Quickstart

Do Your Work Smoothly With CLI

1. Install

npm install engine-ai

OR Install Globally

npm install -g engine-ai

2. Initilize Engine CLI

Run :- eng start
You Will See // ⇨ 'Welcome To Engine CLI'

For Any Kind Of Help Run engine start -h utility name and -h Or --help ...

⚙️ Setup Execution Policy (Windows Users Only) Optional

If you are a Windows user and encounter an error related to the execution policy (e.g., set-executionpolicy), follow these steps to allow your CLI tool to run scripts:

📝 Steps:

1. Open PowerShell:

   • Right-click on the Start menu and select Windows PowerShell (Admin).

2. Check Current Execution Policy:

   • Before changing the policy, you can check the current setting by running:

     Get-ExecutionPolicy

3. Set Execution Policy:

   • Run the following command to set the execution policy to RemoteSigned:

     Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

4. Confirm the Change:

   • When prompted, type Y and press Enter.

5. Verify the Policy:

   • To verify the change, you can run:

     Get-ExecutionPolicy -Scope CurrentUser

   It should now display RemoteSigned.

6. Close PowerShell:

   • After making the change, close the PowerShell window.

7. Run Your CLI:

   • Now, you should be able to run the CLI command without any issues.

❓ Why is this Required?

Windows has a built-in security feature that prevents running scripts from untrusted sources. By changing the execution policy to RemoteSigned, you are allowing scripts that are downloaded from the internet to run, provided they are signed by a trusted publisher. This ensures a balance between security and usability.

With these steps completed, you can continue using the CLI tool on Windows without any execution policy errors!

📅 API Summary

| | | | | --- | --- | --- | | eng start | To Initilize the CLI | New in [email protected] | | eng start tp | To Create A Template | New in [email protected] | | eng start ai | Start Generative AI For Help | New in [email protected] | |

⚡ API Details

eng_start

This Will Start CLI Engine.

Example:

Run :- eng start
You Will See // ✔ ⇨ 'Welcome To Engine CLI'

eng_start_tp

This Will Propmt For The Choosing The Kinds Of Templates ...

Example:

Run :- eng start tp

Please select a template:

• ⚛️ React
• 🖥️ Express
• 🌐 HTML

eng_start_ai

This Will Propmt For The Choosing The Kinds Of AI Help ...

Example:

Run :- eng start ai

You Will Be Prompted For

• 📚 General: Get help with general queries or prompts.
• 🛠️ Modifying a File Based on the Prompt: Update a specific file according to the prompt.

📄 Genral

Choose Genral Help if you want to solve your doubt or any specific purpose for example :- give the propmt and see your answer as usual on Chat GPT. Right from you terminal

🛠️ Modifying A FIle Based On The Prompt

Choose this option if you want the help for a specefic file and based on the prompt you want to update your file.

✨ Examples

    * Suppose you are in root directory of your vite project

Command : eng start ai ./src/App.jsx

Prompt : Change this component to the counter component

Response :

• Your Counter Component has been genrated

• see in the terminal

• if you satisfy from this output

• And it will peompt for the overwrite the content which is inside the App.jsx

• If choose Yes

• it insert the newly genrated code To the App.jsx

✨ Features

• Create Template
• Remove Unnecessary code from the Template
• AI Integrated
• Modify File with response genrated by AI

🔑 Key Highlights:

1. 🚀 and 📦 Icons to give a visual appeal to different sections.
2. A clear instruction for Windows users to set the execution policy manually.
3. The usage of command blocks to make instructions clear and readable.

This should help users understand how to fix the execution policy error and run your CLI tool successfully.

📬 Contact

For any questions or support, please reach out to us at [email protected].