Skip to content

Commit

Permalink
docs: improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Oct 31, 2023
1 parent 50b00a0 commit f59d4ac
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ A local alternative to ChatGPT's "Advanced Data Analysis" (previously "Code Inte

- 💻 Code execution
- Directly execute code (shell and Python) in your local environment.
- Allows use of cli tools like `gh` to access GitHub, `curl` to access the web, etc.
- Lets the assistant use commandline tools to work with files, access the web, etc.
- Executed code maintains state in a REPL-like manner.
- 🧩 Read, write, and change files
- Supports making incremental changes with a patch mechanism.
Expand All @@ -45,6 +45,9 @@ A local alternative to ChatGPT's "Advanced Data Analysis" (previously "Code Inte
- Commands have their output fed back to the agent, allowing it to self-correct.
- 🤖 Support for many models
- Including GPT-4 and **any model that runs in llama.cpp**
- ✨ Many smaller features to ensure a great experience
- Tab completion
- Automatic naming of conversations

🚧 In progress:

Expand Down Expand Up @@ -115,21 +118,19 @@ Usage: gptme [OPTIONS] [PROMPTS]...

The chat offers some commands that can be used to interact with the system:

/continue Continue response.
/undo Undo the last action.
/log Show the conversation log.
/edit Edit previous messages.
/rename Rename the conversation.
/fork Create a copy of the conversation with a new name.
/summarize Summarize the conversation so far.
/load Load a file.
/save Save the most recent code block to a file.
/shell Execute a shell command.
/python Execute a Python command.
/replay Re-execute past commands in the conversation (does not store output in log).
/undo Undo the last action.
/log Show the conversation log.
/edit Edit the conversation in your editor.
/rename Rename the conversation.
/fork Create a copy of the conversation with a new name.
/summarize Summarize the conversation.
/save Save the last code block to a file.
/shell Execute shell code.
/python Execute Python code.
/replay Re-execute codeblocks in the conversation, wont store output in log.
/impersonate Impersonate the assistant.
/help Show this help message.
/exit Exit the program.
/help Show this help message.
/exit Exit the program.

Options:
--prompt-system TEXT System prompt. Can be 'full', 'short', or
Expand Down
2 changes: 1 addition & 1 deletion gptme/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@

script_path = Path(os.path.realpath(__file__))
action_readme = "\n".join(
f" {CMDFIX}{cmd:10s} {desc}." for cmd, desc in action_descriptions.items()
f" {CMDFIX}{cmd:11s} {desc}." for cmd, desc in action_descriptions.items()
)


Expand Down

0 comments on commit f59d4ac

Please sign in to comment.