Skip to content

Commit 33e2a0f

Browse files
committed
updated
1 parent ccc3d71 commit 33e2a0f

File tree

10 files changed

+98
-31
lines changed

10 files changed

+98
-31
lines changed

docs/agents/AgentTypes/UniversalAgents/createUniversalAgents.md

+56-27
Original file line numberDiff line numberDiff line change
@@ -3,53 +3,82 @@
33
A custom universal agent is a type of agent in CodeBolt designed to interact dynamically with user messages and handle specific actions or workflows. The agent interprets a structured `Message` payload and returns a tailored `ResponseMessage`, specifying instructions for various tasks such as code generation, testing, deployment, and more.
44

55

6-
### Data Types
7-
* Message: Contains user input and details of the current context, including the selected agent, referenced files, folders, actions, and other agents involved in the request.
6+
### create custom universal Agent
87

98
```bash
9+
//you will get this request form codebolt
1010
export type Message = {
1111
userMessage: string;
1212
currentFile: string;
1313
selectedAgent: { id: string; name: string; lastMessage: object };
1414
mentionedFiles: string[];
1515
mentionedFolders: string[];
1616
actions: string[];
17-
mentionedAgents: any[];
17+
mentionedAgents: any[]; // Specify the type if known
1818
universalAgentLastMessage: string;
1919
};
20-
```
21-
22-
* Instruction: Describes a single action or step for an agent to take in response to the `Message`.
2320

24-
```bash
2521
export type Instruction = {
26-
agentId: string;
27-
step: Steps;
28-
action: string;
29-
prompt: string;
22+
agentId: string;
23+
step: Steps;
24+
action: string;
25+
prompt: string;
3026
};
3127

32-
```
33-
34-
* ResponseMessage: The output format expected from the custom universal agent, containing a list of instructions.
35-
36-
```bash
28+
//this is type of response you need to send
3729
export type ResponseMessage = {
38-
instructions: Instruction[];
30+
instructions: Instruction[];
3931
};
4032

33+
export enum Steps {
34+
USER_QUESTION = 'userquestion',
35+
CODE_GENERATION = 'codegeneration',
36+
TESTING = 'testing',
37+
DEPLOY = 'deploy',
38+
DOCUMENTATION = 'documentation',
39+
REVIEW = 'review'
40+
}
41+
4142
```
4243
44+
* Message: Contains user input and details of the current context, including the selected agent, referenced files, folders, actions, and other agents involved in the request.
45+
46+
* Instruction: Describes a single action or step for an agent to take in response to the `Message`.
47+
48+
* ResponseMessage: The output format expected from the custom universal agent, containing a list of instructions.
49+
4350
* Steps : Enumerates the different stages an agent might use to process the user's request, allowing for more organized workflows.
4451
45-
```bash
46-
export enum Steps {
47-
USER_QUESTION = 'userquestion',
48-
CODE_GENERATION = 'codegeneration',
49-
TESTING = 'testing',
50-
DEPLOY = 'deploy',
51-
DOCUMENTATION = 'documentation',
52-
REVIEW = 'review'
53-
}
5452
55-
```
53+
```bash
54+
const express = require('express');
55+
const app = express();
56+
const port = 3000;
57+
58+
// Middleware to parse JSON request bodies
59+
app.use(express.json());
60+
61+
// Define your endpoint
62+
app.post('/message', (req, res) => {
63+
const message = req.body; // Extracting the Message from the request body
64+
65+
// write you logic to filter agent based on user message
66+
const responseMessage = {
67+
instructions: [
68+
{
69+
agentId: selectedAgent.id,
70+
step: 'USER_QUESTION', // As an example step
71+
action: 'Process the message',
72+
prompt: message.userMessage
73+
}
74+
]
75+
};
76+
//this is the format of respose you will need to send back
77+
78+
res.json(responseMessage);
79+
);
80+
// Start the server
81+
app.listen(port, () => {
82+
console.log(`Server is running on http://localhost:${port}`);
83+
});
84+
```
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
#
1+
# Integrated Universal Agent
2+
3+
The Integrated Universal Agent is the default agent included in the CodeBolt editor, There is one Universal Agent that is integrated within the Codebolt Editor. This ensures that the code does not leaves the editor as well as also to decreate the response latency.
4+
5+
- We have an option to create your own Universal Agents. You can learn more about them at [Create your own Universal Agents](./createUniversalAgents.md)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
3+
comming soon...

docs/agents/modules/1_index.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Codebolt Modules
22

3-
## What are modules?
3+
comming soon...
44

5-
## Module Access through API
5+
<!-- ## What are modules?
6+
7+
## Module Access through API -->

docs/apps/index.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
11
# Apps
22

3-
[![app start](../../static/img/codebolt_application.png)](../../static/video/appStart.mp4)
3+
This app allows users to create and publish their own applications. It’s designed to be collaborative, enabling other users to explore, modify, and customize existing apps for their purposes. With features like `Start` and `Fork and Edit`, users can easily build upon existing apps to create new functionalities or tailor apps to their specific needs.
4+
5+
[![app start](../../static/img/appList.png)](../../static/video/appStart.mp4)
6+
7+
**Create a New App**
8+
* You can make your own app from scratch.
9+
10+
* When your app is ready, you can publish it for others to see and use.
11+
12+
* you can Download Apps from the Marketplace, The Marketplace has many apps shared by other users.
13+
14+
* You can browse, download, and use these apps.
15+
16+
* **Fork and Edit Apps**: you Want to make changes to an app you downloaded? You can fork (copy) and edit it.
17+
18+
![installedApp](../../static/img/installedApp.png)

docs/user/features/controlK.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Ctrl K
2+
3+
Ctrl K lets you edit and write code with the codebolt AI. To edit, try selecting some code, click "Edit," and describe how the code should be changed. To generate completely new code, just type Ctrl K without selecting anything.
4+
5+
![cntrlK](../../../static/img/cntrlK.png)

docs/user/features/llms.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# LLMs Feature
2+
3+
- The **LLMs** feature provides the flexibility to select from multiple AI providers, each offering a variety of language models to suit different needs. Available providers include:
4+
- **CodeBolt AI**
5+
- **OpenAI**
6+
- **LM Studio**
7+
- Additionally, you can explore and choose from the **Available Models** within each provider.
8+
9+
![LLMs Settings](../../../static/img/llm-setting.png)

static/img/appList.png

88.2 KB
Loading

static/img/cntrlK.png

89.8 KB
Loading

static/img/installedApp.png

76.1 KB
Loading

0 commit comments

Comments
 (0)