Skip to content

Commit 948aab0

Browse files
committed
add description of url text retrieval to README
1 parent c4652de commit 948aab0

1 file changed

Lines changed: 18 additions & 14 deletions

File tree

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,28 @@ This is currently in development, but is already useable. (In fact I use it on i
77

88
## Purpose
99

10-
The `Developers ChatGPT ToolBench` is a Java application designed to provide a plugin for ChatGPT that allows the AI to
11-
access, read, and write files in the directory where the plugin is started. The plugin is implemented as an
12-
executable jar. If you check out and compile this Git repository, you can also use the script
13-
[bin/developersToolBenchPlugin](bin/developersToolBenchPlugin) after building it with
10+
The `Developers ChatGPT ToolBench` is a Java application designed to provide a plugin for ChatGPT that allows the AI to
11+
access, read, and write files in the directory where the plugin is started. The plugin is implemented as an
12+
executable jar. If you check out and compile this Git repository, you can also use the script
13+
[bin/developersToolBenchPlugin](bin/developersToolBenchPlugin) after building it with
1414
[bin/developersToolBenchPlugin-buildStable](bin/developersToolBenchPlugin-buildStable).
1515

1616
The plugin provides several operations, including:
1717

1818
- Listing the files in a directory
1919
- Reading the contents of a file
20-
- Writing content to a file
20+
- Writing content to a file / changing file content
2121
- searching for regular expressions in files
2222
- Executing a shell script with given content as standard input
23+
- fetch the text content of an URL
2324

2425
Caution: you currently need to be a paying user of ChatGPT (to have access to ChatGPT-4) and to be registered for the
2526
ChatGPT Plugin beta, probably as a plugin developer.
2627

2728
## Status
2829

29-
It's useable; I'll be likely making extensions to it since I'm using it quite often when I'm asking ChatGPT questions.
30+
I'm regularily use it for my own development, and it seems quite stable. I'm using it quite often when I'm asking
31+
ChatGPT questions or small extensions.
3032

3133
## Usage
3234

@@ -63,35 +65,37 @@ Here are some examples of how to use the `Developers ChatGPT ToolBench`:
6365
- **Write File**: To write content to a file, you can use the `writeFile` operation. In ChatGPT, you would ask the AI to
6466
write a specific content to a file, and it would send a request to the plugin to perform this operation.
6567

66-
- **Search Files**: to search for Strings in files, you can use the 'grepFiles' operation. In ChatGPT, you could ask
68+
- **Search Files**: to search for Strings in files, you can use the 'grepFiles' operation. In ChatGPT, you could ask
6769
to search for files with a file name pattern and containing a string or pattern.
6870

6971
- **Execute Action**: To execute a shell script with given content as standard input, you can use the `executeAction`
7072
operation. In ChatGPT, you would ask the AI to execute a specific action, and it would send a request to the plugin to
7173
perform this operation. The shell script should be located at `.cgptfmgr/{actionName}.sh`, where `{actionName}` is a
72-
parameter provided in the query string. The content is passed as standard input to the shell script. Some examples
74+
parameter provided in the query string. The content is passed as standard input to the shell script. Some examples
7375
are in [.cgptdevbench/](.cgptdevbench/) and
7476
[src/test/resources/testdir/.cgptdevbench](src/test/resources/testdir/.cgptdevbench) .
75-
7677

77-
Remember, the `Developers ChatGPT ToolBench` operates on the directory where it was started,
78-
so be careful to start it in a directory that contains the files you want to access.
78+
- **Fetch the text content of an URL**: gives ChatGPT simple web access: this can perform a GET request and returns
79+
the text content of the URL (not the HTML) to ChatGPT.
80+
81+
Remember, the `Developers ChatGPT ToolBench` operates on the directory where it was started,
82+
so be careful to start it in a directory that contains the files you want to access.
7983

8084
## Configuring FileManagerPlugin for use in ChatGPT
8185

82-
To use the `Developers ChatGPT ToolBench` with ChatGPT, you need to register it as a plugin in the ChatGPT interface.
86+
To use the `Developers ChatGPT ToolBench` with ChatGPT, you need to register it as a plugin in the ChatGPT interface.
8387
Here's a step-by-step guide on how to do this:
8488

8589
1. **Register as a Plugin Developer**: If you haven't already, register as a plugin developer with ChatGPT. This will
8690
give you access to the plugin developer interface where you can add your own plugins.
8791

88-
2. **Start the Plugin**: Navigate to the directory you want to access and run the `Developers ChatGPT ToolBench`
92+
2. **Start the Plugin**: Navigate to the directory you want to access and run the `Developers ChatGPT ToolBench`
8993
program. This will start a server on port 3002 (by default).
9094

9195
3. **Add the Plugin**: In the ChatGPT interface, navigate to the plugin developer section and select "Develop your own
9296
plugin", and enter the url `localhost:3002`
9397

9498
4. **Test the Plugin**: Once you've added the plugin, you can test it in the ChatGPT interface. Try asking the AI to
95-
list the files in the directory, read a specific file, write to a file, or execute a specific action after
99+
list the files in the directory, read a specific file, write to a file, or execute a specific action after
96100
setting up some actions in a .cgptdevbench directory in the directory you're running it. If everything
97101
is set up correctly, the AI should be able to perform these operations using the plugin.

0 commit comments

Comments
 (0)