Merge branch 'main' of https://github.com/codeboltai/codeboltai.github.io

Author: Nursid

docs/agents/1_agentIntroduction.md

@@ -1,4 +1,4 @@
-# Agents Introduction
+# App Introduction
 
 Codebolt is an extremely powerful tool for AI Code Editing and AI Code Generation. Most of the power of Codebolt comes from the ability to use Agents. These agents are powerful tools that can be used to automate tasks, generate code, and even create entire applications. 
 
@@ -7,11 +7,11 @@ Codebolt is an extremely powerful tool for AI Code Editing and AI Code Generatio
 Codebolt uses AI Agents for doing all the actions. Thing of Codebolt Editor as a big Agent Orchestrator that can use any agent in the marketplace to do any task.
 AI Agents interface with Codebolt using Codebolt Editor APIs. They can run any logic from talking to LLMs, updating the code, and any other tasks. They can use decision making power of LLMs to make decisions and take actions.
 
-## Codebolt Editor APIs
+<!-- ## Codebolt Editor APIs
 
 Codebolt Editor exposes all the functionality of the Editor in the format of APIs. We have created various Libraries to access the Editor APIs. These libraries are available in the following languages:
 - [JavaScript](https://github.com/codebolt-ai/codebolt-js)
-- [Python](https://github.com/codebolt-ai/codebolt-python)
+- [Python](https://github.com/codebolt-ai/codebolt-python) -->
 
 ## Codebolt Agents
 

docs/agents/2_firstExtension.md

@@ -1,56 +1,45 @@
 # Create your First Agent
 
-
 ## Create Codebolt Agent
-
 Follow the steps below to create a new agent using Codebolt.
 
-### Step 1: Choose Your Method to Create an Agent
-- **Option 1: Use Agent Template**  
-  Open Codebolt Application. Create Project In Workspace >  Select Agent Template > Create Project
-  ![create agent](../../static/img/createAgent.png)
+### Step 1: Select or Create a Project for Agent Creation
 
-- *Navigate to the .codeboltAgents directory.*
-   ```bash
-      cd .codeboltAgents
-   
-   ```
+  ![create agent](../../static/img/create-agent.png)
 
-- **Option 2: Use Npx Command**  
-  Open your terminal in the directory where you want the agent to be created and run the following command:  
-  ```bash
-  npx create-codebolt-agent your-agent-name
-  ```
+- *After creating or opening a project, open a terminal to create an agent.*
 
-![create agent](../../static/img/agent-create.png)
+### Step 2: Initialize the Agent Creation Process
 
-### Step 2: Fill in the Required Information
-After running the command, you'll be prompted to provide several details. Here are the inputs you need:
+1. Open your terminal in the project directory
+2. Type the following command:
+   ```bash
+   npx codebolt-cli createagent demoAgent --quick
+   ```
+ 
+ ![open terminal](../../static/img/open-terminal.png)  
+3. Press Enter to execute the command
 
-- Application Name: The name of your application **(e.g., myagent)**. 
-- Unique ID: A unique identifier for the agent **(e.g., myagent)**.
-- Installation Path: The path where your agent will be installed **(e.g., C:\btpl\codeboltapp\crud\myagent)**.
-- Template: Select a template for your application **(e.g., basic)**.
-- Description: Provide a description for your agent **(e.g., My Codebolt Agent)**.
-- Tags: Enter tags for your agent **(comma-separated, e.g., test)**.
-- Works on Blank Code: Choose **Yes** if your agent works on blank code.
-- Works on Existing Code: Choose **Yes** if your agent works on existing code.
-- Supported Languages: Specify the languages your agent will support **(e.g., all, javascript, typescript)**.
-- Supported Frameworks: Select the frameworks your agent will support **(e.g., all, nextjs)**.
+   - `demoAgent`: This is the name of your agent (can be customized)
+   - `--quick`: This flag creates a basic agent template with default configurations
+### Step 3: Understanding the Agent Structure
 
-- **Step 3: Configure SDLC Steps**
+After successful creation, your agent will have the following structure:
+```
+.codeboltAgents/
+└── demoAgent/
+    ├── codeboltagent.yaml       # Agent configuration file
+    ├── agent.yaml        # contains Prompt for agent
+    ├── task.yaml          # contains instruction for task
+```
 
-- The SDLC (Software Development Life Cycle) steps define what tasks your agent will handle **(e.g., code generation, deployment)**. Here's an example configuration:
+### Step 4: Verify Agent Creation
 
-- **SDLC Step Name: codegeneration**
-- Instruction Description: Generate a new React component
-Once you've provided these details, you'll be asked if you want to add more SDLC steps. Choose No if you don’t need additional steps.
+- *After successfully creating the agent, you can find your agent inside the .codeboltAgents folder.*
+  ![after success](../../static/img/after-creation.png)
 
-- **Step 4: Add Action Steps**
-Actions represent the functionalities your agent provides. For example:
+### Step 5: Next Steps
 
-- Action Name: **Execute**
-- Action Description: **Executes the given task**
-- Detail Description (Optional): **more detailed description**
-- Action Prompt (Optional): **Please run this code**
-- You can add more actions if needed.
+1. Open the `codeboltagent.yaml` file to customize your agent's settings
+2. Configure your agent's prompt in the `agent.yaml` file
+3. Define tasks and instructions in the `task.yaml` file

docs/agents/3_runExtension.md

@@ -0,0 +1,37 @@
+# Run Local Agent in Codebolt
+
+This guide will walk you through the process of running a local agent in Codebolt. Local agents allow you to use custom-built AI assistants directly within your development environment.
+
+## Step-by-Step Guide
+
+### 1. Access the Agent Menu
+- Open Codebolt and locate the "Agent" section in the main toolbar
+- Click on the "Agent: auto chat" header to open the agent selection menu
+
+![install agent](../../static/img/select-auto.png)
+
+### 2. Navigate to Local Agents
+- In the popup window, you'll see three tabs:
+  - **Installed**: Shows currently active agents
+  - **MarketPlace**: Contains pre-built agents available for download
+  - **Local**: Displays agents stored on your machine
+- Click on the "Local" tab to view your available local agents
+
+![runlocal Agent](../../static/img/select-local-agent.png)
+### 3. Select Your Agent
+- Browse through the list of local agents
+- Each agent will display its name and basic information
+- Click on the agent you want to activate
+
+
+![runlocal Agent](../../static/img/select-agent.png)
+
+
+- After selection, the selected agent will be activated.
+
+
+![runlocal Agent](../../static/img/after-selection.png)
+## Troubleshooting Tips
+- If you don't see your local agent:
+  - Verify the agent files are in the correct directory
+  - Restart Codebolt and try again

docs/agents/4_runExtension.md

@@ -1,5 +1,8 @@
 ---
 cbapicategory:
+    - name: Agent
+      link: /docs/api/agent
+      description: This module provides functionalities for creating customized, high-performance agents tailored to specific needs.
     - name: Browser
       link: /docs/api/browser
       description: The browser module provides functions for interacting with the browser.

docs/agents/3_publishExtension.md renamed to docs/agents/5_publishExtension.md

@@ -0,0 +1,11 @@
+{
+  "label": "Agent",
+  "position": 2.5,
+  "collapsible": true,
+  "collapsed": true,
+  "className": "red",
+  "link": {
+    "type": "doc",
+    "id": "api/agent/index"
+  }
+}

docs/api/1_api_index.md

@@ -0,0 +1,63 @@
+---
+name: findAgent
+cbbaseinfo:
+  description: Finds an agent suitable for the specified task.
+cbparameters:
+  parameters:
+    - name: task
+      typeName: string
+      description: The task for which an agent is needed.
+    - name: maxResult
+      typeName: number
+      description: Maximum number of agents to return (default 1).
+    - name: agents
+      typeName: array
+      description: List of agents to filter in vector database.
+    - name: agentLocation
+      typeName: AgentLocation
+      description: Location preference for agents (ALL, LOCAL_ONLY, REMOTE_ONLY).
+    - name: getFrom
+      typeName: FilterUsing
+      description: Filtering method (USE_AI, USE_VECTOR_DB, USE_BOTH).
+  returns:
+    signatureTypeName: Promise
+    description: A promise that resolves with the agent details.
+    typeArgs:
+      - type: reference
+        name: any
+data:
+  name: findAgent
+  category: agent
+  link: findAgent.md
+---
+<CBBaseInfo/>
+<CBParameters/>
+
+### Examples
+
+```js
+// Example 1: Find a single agent for a task
+const agent = await codebolt.agent.findAgent("dataProcessing");
+console.log("Found Agent:", agent);
+
+// Example 2: Find multiple agents with specific filters
+const agents = await codebolt.agent.findAgent(
+  "imageProcessing",
+  3, // maxResult
+  [], // agents
+  codebolt.agent.AgentLocation.LOCAL_ONLY,
+  codebolt.agent.FilterUsing.USE_VECTOR_DB
+);
+console.log("Found Agents:", agents);
+
+// Example 3: Find agents using AI filtering
+const aiFilteredAgents = await codebolt.agent.findAgent(
+  "naturalLanguageProcessing",
+  2,
+  [],
+  codebolt.agent.AgentLocation.ALL,
+  codebolt.agent.FilterUsing.USE_AI
+);
+console.log("AI Filtered Agents:", aiFilteredAgents);
+```
+

docs/api/agent/_category_.json

@@ -0,0 +1,43 @@
+---
+name: getAgentsList
+cbbaseinfo:
+  description: Retrieves a list of agents based on the specified type.
+cbparameters:
+  parameters:
+    - name: type
+      typeName: Agents
+      description: The type of agents to list (default is Agents.DOWNLOADED)
+  returns:
+    signatureTypeName: Promise
+    description: A promise that resolves with the list of agents
+    typeArgs:
+      - type: reference
+        name: any
+data:
+  name: getAgentsList
+  category: agent
+  link: getAgentsList.md
+---
+<CBBaseInfo/>
+<CBParameters/>
+
+### Example
+
+```js
+// Example 1: Getting list of downloaded agents (default)
+const downloadedAgents = await codebolt.agent.getAgentsList();
+console.log("Downloaded Agents:", downloadedAgents);
+
+// Example 2: Getting list of local agents
+const localAgents = await codebolt.agent.getAgentsList(Agents.LOCAL);
+console.log("LOCAL Agents:", localAgents);
+
+// Example 3: Getting list of cloud agents
+const cloudAgents = await codebolt.agent.getAgentsList(Agents.CLOUD);
+console.log("CLOUD Agents:", cloudAgents);
+
+// Example 4: Getting list of all agents
+const allAgents = await codebolt.agent.getAgentsList(Agents.ALL);
+console.log("ALL Agents:", allAgents);
+```
+

docs/api/agent/findAgent.md

@@ -6,6 +6,12 @@ cbapicategory:
   - name: startAgent
     link: /docs/api/agent/startAgent
     description: Starts an agent for the specified task via WebSocket.
+  - name: findAgent
+    link: /docs/api/agent/findAgent
+    description: Retrieves an agent based on the specified task with filtering options.
+  - name: getAgentsList
+    link: /docs/api/agent/getAgentsList
+    description: Lists all available agents of a specific type.
 ---
 # Agent
-<CBAPICategory />
+<CBAPICategory />

docs/api/agent/getAgentList.md

@@ -0,0 +1,6 @@
+# Apps Introduction
+
+
+### What is a Codebolt Applications?  
+
+Codebolt is a powerful platform that allows users to create and publish applications effortlessly. Once an application is built using Codebolt, it can be published for others to use, making it accessible to a broader audience. These published applications are known as **Codebolt Applications**, enabling seamless sharing and deployment of innovative solutions. Whether for personal projects or large-scale development, Codebolt simplifies the process of bringing applications to life and distributing them efficiently.

docs/api/agent/index.md

@@ -0,0 +1,58 @@
+# Publish Your First App
+
+This guide walks you through the process of publishing your application using Codebolt.
+
+## Step 1: Create Your Application
+1. Navigate to the application creation interface
+2. Configure your application's basic settings
+3. Confirm the creation process
+
+![create agent](../../static/img/create-ui-app.png)
+
+## Step 2: Configure Application Settings
+1. Set up all application-related configurations
+2. Define the required parameters for your application
+
+![after success](../../static/img/app-use-setting.png)
+
+## Step 3: Provide Technical Information
+1. Fill in all technical details about your application
+2. Include system requirements and compatibility information
+
+![technical](../../static/img/tech-info.png)
+
+## Step 4: Configure Development Settings
+1. Set up your development environment parameters
+2. Define build and deployment configurations
+
+![development setting](../../static/img/develop-setting.png)
+
+## Step 5: Configure Installation Settings
+1. Specify installation requirements and procedures
+2. Define any pre-installation or post-installation steps
+
+![installation setting](../../static/img/installation-setting.png)
+
+## Step 6: Configure Application Usage Settings
+1. Define how users will interact with your application
+2. Set up any required user permissions or access controls
+
+![app using setting](../../static/img/app-use-setting.png)
+
+## Step 7: Publish Your Application
+1. Review all settings and configurations
+2. Click the "Publish" button to make your application live
+
+![publish app](../../static/img/publish-app.png)
+
+## Step 8: Verify Your Application Structure
+1. Review the final application structure
+2. Confirm all components are properly configured
+
+![confirm](../../static/img/confirm.png)
+
+
+## Step 9: Find Your Application
+1. Locate your newly created application
+
+![find app](../../static/img/after-install.png)