refactor: rename fabric_code tool to code_helper for clarity

## CHANGES

- Rename tool from `fabric_code` to `code_helper`
- Update all documentation references to the tool
- Update installation instructions in README
- Modify usage examples in documentation
- Update tool's self-description and help text
This commit is contained in:
Kayvan Sylvan
2025-03-25 19:14:25 -07:00
parent 3785d0a5fa
commit daad5f986e
4 changed files with 16 additions and 16 deletions

View File

@@ -4,10 +4,10 @@ Generate code changes to an existing coding project using AI.
## Installation
After installing the `fabric_code` binary:
After installing the `code_helper` binary:
```bash
go install github.com/danielmiessler/fabric/plugins/tools/fabric_code@latest
go install github.com/danielmiessler/fabric/plugins/tools/code_helper@latest
```
## Usage
@@ -15,18 +15,18 @@ go install github.com/danielmiessler/fabric/plugins/tools/fabric_code@latest
The create_coding_feature allows you to apply AI-suggested code changes directly to your project files. Use it like this:
```bash
fabric_code [project_directory] "[instructions for code changes]" | fabric --pattern create_coding_feature
code_helper [project_directory] "[instructions for code changes]" | fabric --pattern create_coding_feature
```
For example:
```bash
fabric_code . "Create a simple Hello World C program in file main.c" | fabric --pattern create_coding_feature
code_helper . "Create a simple Hello World C program in file main.c" | fabric --pattern create_coding_feature
```
## How It Works
1. `fabric_code` scans your project directory and creates a JSON representation
1. `code_helper` scans your project directory and creates a JSON representation
2. The AI model analyzes your project structure and instructions
3. AI generates file changes in a standard format
4. Fabric parses these changes and prompts you to confirm
@@ -36,7 +36,7 @@ fabric_code . "Create a simple Hello World C program in file main.c" | fabric --
```bash
# Request AI to create a Hello World program
fabric_code . "Create a simple Hello World C program in file main.c" | fabric --pattern create_coding_feature
code_helper . "Create a simple Hello World C program in file main.c" | fabric --pattern create_coding_feature
# Review the changes made to your project
git diff
@@ -52,7 +52,7 @@ git commit -s -m "Add Hello World program"
### Security Enhancement Example
```bash
fabric_code . "Ensure that all user input is validated and sanitized before being used in the program." | fabric --pattern create_coding_feature
code_helper . "Ensure that all user input is validated and sanitized before being used in the program." | fabric --pattern create_coding_feature
git diff
make check
git add <changed files>