Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md (first paragraph rewording) #5

Merged
merged 3 commits into from
Jun 22, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Reword README.md (first paragraph)
Reworded the first paragraph of README.md to make it more clear what Nerve is capable of doing.
  • Loading branch information
5ibyl authored Jun 22, 2024
commit 5ba8062f842d50a6c3c915c2ff89c179499458ad
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@
<a href="https://github.com/evilsocket/nerve/blob/master/LICENSE.md"><img alt="Software License" src="https://img.shields.io/badge/license-GPL3-brightgreen.svg?style=flat-square"></a>
</p>

Nerve is a tool that allows creating stateful agents with any LLM of your choice - without writing a single line of code.
The tool provides to the model a framework of functionalities for planning, saving or recalling memories, etc (you can think about it as a "standard library" of functions for the LLM to use) by dynamically adapting the prompt and making it stateful over multiple inferences. The model will be able to access and use these functionalities in order to accomplish the task you provided.
**Nerve is a tool that creates stateful agents with any LLM — without writing a single line of code.** Agents created with Nerve are capable of both planning _and_ enacting step-by-step whatever actions are required to complete a user-defined task. This is done by dynamically updating the system prompt with new information gathered through the agent's previous actions, making the agent stateful across multiple inferences.
- **Automated Problem Solving:** Nerve provides a standard library of actions the agent uses autonomously to inform and enhance its performance. These include identifying specific goals required to complete the task, devising and revising a plan to achieve those goals, and creating and recalling memories comprised of pertinent information gleaned during previous actions.
- **User-Defined Agents:** Agents are defined using a standard YAML template. _The sky is the limit!_ You can define an agent for any task you desire — check out the existing examples for inspiration: a [two-person chatroom](https://github.com/evilsocket/nerve/blob/main/examples/weird_chat/task.yml), an [SSH agent that completes tasks using bash](https://github.com/evilsocket/nerve/blob/main/examples/ssh_agent/task.yml), a [fuzzer](https://github.com/evilsocket/nerve/blob/main/examples/fuzzer/task.yml), and a [web vulnerability scanner](https://github.com/evilsocket/nerve/blob/main/examples/web_vulnerability_scanner/task.yml).
- **Works with any LLM:** Nerve is an LLM-agnostic tool. Currently, it features integrations for any model accessible via the [ollama](https://github.com/ollama/ollama) or [OpenAI](https://openai.com/index/openai-api/) APIs.


<p align="center">
<img alt="Nerve" src="https://raw.githubusercontent.com/evilsocket/nerve/main/concept.png"/>
Expand Down Expand Up @@ -145,4 +148,4 @@ docker run -it --network=host -v /path/to/your/tasklet:/app/tasklet nerve -h

Nerve is released under the GPL 3 license. To see the licenses of the project dependencies, install cargo license with `cargo install cargo-license` and then run `cargo license`.

[![Star History Chart](https://api.star-history.com/svg?repos=evilsocket/nerve&type=Date)](https://star-history.com/#evilsocket/nerve&Date)
[![Star History Chart](https://api.star-history.com/svg?repos=evilsocket/nerve&type=Date)](https://star-history.com/#evilsocket/nerve&Date)