From 1ce82372fdfc1dc592971e935d30c40d4e0eb8d5 Mon Sep 17 00:00:00 2001 From: Reinier van der Leer Date: Fri, 24 Nov 2023 18:59:18 +0100 Subject: refactor: Rename Agent's entrypoint to autogpt.sh - Renamed `run.sh` to `autogpt.sh` for consistent naming and easier command usage. - Updated relevant documentation to reflect the new entrypoint name. --- docs/content/AutoGPT/setup/index.md | 2 +- docs/content/AutoGPT/share-your-logs.md | 4 ++-- docs/content/AutoGPT/usage.md | 26 +++++++++++++------------- 3 files changed, 16 insertions(+), 16 deletions(-) (limited to 'docs') diff --git a/docs/content/AutoGPT/setup/index.md b/docs/content/AutoGPT/setup/index.md index 4b18f074c..2bf6724f4 100644 --- a/docs/content/AutoGPT/setup/index.md +++ b/docs/content/AutoGPT/setup/index.md @@ -97,7 +97,7 @@ Once you have cloned or downloaded the project, you can find the AutoGPT Agent i 8. _Optional: run `poetry install` to install all required dependencies._ The application also checks for and installs any required dependencies when it starts. -You should now be able to explore the CLI (`./run.sh --help`) and run the application. +You should now be able to explore the CLI (`./autogpt.sh --help`) and run the application. See the [user guide](../usage.md) for further instructions. diff --git a/docs/content/AutoGPT/share-your-logs.md b/docs/content/AutoGPT/share-your-logs.md index 9fc6fef3d..3f4139ce1 100644 --- a/docs/content/AutoGPT/share-your-logs.md +++ b/docs/content/AutoGPT/share-your-logs.md @@ -9,9 +9,9 @@ Activity, Error, and Debug logs are located in `./logs` To print out debug logs: ```shell -./run.sh --debug # on Linux / macOS +./autogpt.sh --debug # on Linux / macOS -.\run.bat --debug # on Windows +.\autogpt.bat --debug # on Windows docker-compose run --rm auto-gpt --debug # in Docker ``` diff --git a/docs/content/AutoGPT/usage.md b/docs/content/AutoGPT/usage.md index 2229771d4..e1f5bd8cc 100644 --- a/docs/content/AutoGPT/usage.md +++ b/docs/content/AutoGPT/usage.md @@ -6,11 +6,11 @@ ## Command Line Interface -Running `./run.sh` (or any of its subcommands) with `--help` lists all the possible +Running `./autogpt.sh` (or any of its subcommands) with `--help` lists all the possible sub-commands and arguments you can use: ```shell -$ ./run.sh --help +$ ./autogpt.sh --help Usage: python -m autogpt [OPTIONS] COMMAND [ARGS]... Options: @@ -22,7 +22,7 @@ Commands: ``` !!! important "For Windows users" - On Windows, use `.\run.bat` instead of `./run.sh`. + On Windows, use `.\autogpt.bat` instead of `./autogpt.sh`. Everything else (subcommands, arguments) should work the same. !!! info "Usage with Docker" @@ -40,11 +40,11 @@ The `run` sub-command starts AutoGPT with the legacy CLI interface.
-./run.sh run --help +./autogpt.sh run --help ```shell -$ ./run.sh run --help +$ ./autogpt.sh run --help Usage: python -m autogpt run [OPTIONS] Sets up and runs an agent, based on the task specified by the user, or @@ -96,7 +96,7 @@ This means you can *resume* agents at a later time. See also [agent state]. !!! note For legacy reasons, the CLI will default to the `run` subcommand when none is - specified: running `./run.sh run [OPTIONS]` does the same as `./run.sh [OPTIONS]`, + specified: running `./autogpt.sh run [OPTIONS]` does the same as `./autogpt.sh [OPTIONS]`, but this may change in the future. #### 💀 Continuous Mode ⚠️ @@ -107,7 +107,7 @@ It is potentially dangerous and may cause your AI to run forever or carry out ac Use at your own risk. ```shell -./run.sh --continuous +./autogpt.sh --continuous ``` To exit the program, press ++ctrl+c++ @@ -119,11 +119,11 @@ frontend, by default on `http://localhost:8000`.
-./run.sh serve --help +./autogpt.sh serve --help ```shell -$ ./run.sh serve --help +$ ./autogpt.sh serve --help Usage: python -m autogpt serve [OPTIONS] Starts an Agent Protocol compliant AutoGPT server, which creates a custom @@ -163,18 +163,18 @@ Here are some common arguments you can use when running AutoGPT: * Run AutoGPT with a different AI Settings file ```shell - ./run.sh --ai-settings + ./autogpt.sh --ai-settings ``` * Run AutoGPT with a different Prompt Settings file ```shell - ./run.sh --prompt-settings + ./autogpt.sh --prompt-settings ``` !!! note There are shorthands for some of these flags, for example `-P` for `--prompt-settings`. - Use `./run.sh --help` for more information. + Use `./autogpt.sh --help` for more information. [.env.template]: https://github.com/Significant-Gravitas/AutoGPT/tree/master/autogpts/autogpt/.env.template @@ -200,7 +200,7 @@ Activity, Error, and Debug logs are located in `logs`. To print out debug logs: ```shell -./run.sh --debug +./autogpt.sh --debug ``` ## Disabling Command Categories -- cgit v1.2.3