|
2 | 2 |
|
3 | 3 |
|
4 | 4 | ## Create Codebolt Agent
|
| 5 | + |
| 6 | +Follow the steps below to create a new agent using Codebolt. |
| 7 | + |
| 8 | +### Step 1: Open Your Terminal and Run the Command |
| 9 | + |
| 10 | +Open your terminal in the directory where you want the agent to be created and run the following command: |
| 11 | + |
| 12 | +```bash |
| 13 | +npx create-codebolt-agent your-agent-name |
| 14 | +``` |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | +### Step 2: Fill in the Required Information |
| 19 | +After running the command, you'll be prompted to provide several details. Here are the inputs you need: |
| 20 | + |
| 21 | +- Application Name: The name of your application **(e.g., myagent)**. |
| 22 | +- Unique ID: A unique identifier for the agent **(e.g., myagent)**. |
| 23 | +- Installation Path: The path where your agent will be installed **(e.g., C:\btpl\codeboltapp\crud\myagent)**. |
| 24 | +- Template: Select a template for your application **(e.g., basic)**. |
| 25 | +- Description: Provide a description for your agent **(e.g., My Codebolt Agent)**. |
| 26 | +- Tags: Enter tags for your agent **(comma-separated, e.g., test)**. |
| 27 | +- Works on Blank Code: Choose **Yes** if your agent works on blank code. |
| 28 | +- Works on Existing Code: Choose **Yes** if your agent works on existing code. |
| 29 | +- Supported Languages: Specify the languages your agent will support **(e.g., all, javascript, typescript)**. |
| 30 | +- Supported Frameworks: Select the frameworks your agent will support **(e.g., all, nextjs)**. |
| 31 | + |
| 32 | +- **Step 3: Configure SDLC Steps** |
| 33 | + |
| 34 | +- The SDLC (Software Development Life Cycle) steps define what tasks your agent will handle **(e.g., code generation, deployment)**. Here's an example configuration: |
| 35 | + |
| 36 | +- **SDLC Step Name: codegeneration** |
| 37 | +- Instruction Description: Generate a new React component |
| 38 | +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. |
| 39 | + |
| 40 | +- **Step 4: Add Action Steps** |
| 41 | +Actions represent the functionalities your agent provides. For example: |
| 42 | + |
| 43 | +- Action Name: **Execute** |
| 44 | +- Action Description: **Executes the given task** |
| 45 | +- Detail Description (Optional): **more detailed description** |
| 46 | +- Action Prompt (Optional): **Please run this code** |
| 47 | +- You can add more actions if needed. |
0 commit comments