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.
This commit is contained in:
Reinier van der Leer
2023-11-24 18:59:18 +01:00
parent 6d14f314d7
commit 1ce82372fd
8 changed files with 21 additions and 27 deletions

View File

@@ -34,7 +34,7 @@ see the [setup guide][docs/setup].
## Running AutoGPT ## Running AutoGPT
The CLI should be self-documenting: The CLI should be self-documenting:
```shell ```shell
$ ./run.sh --help $ ./autogpt.sh --help
Usage: python -m autogpt [OPTIONS] COMMAND [ARGS]... Usage: python -m autogpt [OPTIONS] COMMAND [ARGS]...
Options: Options:
@@ -48,13 +48,13 @@ When run without a sub-command, it will default to `run` for legacy reasons.
<details> <details>
<summary> <summary>
<code>$ ./run.sh run --help</code> <code>$ ./autogpt.sh run --help</code>
</summary> </summary>
The `run` sub-command starts AutoGPT with the legacy CLI interface: The `run` sub-command starts AutoGPT with the legacy CLI interface:
```shell ```shell
$ ./run.sh run --help $ ./autogpt.sh run --help
Usage: python -m autogpt run [OPTIONS] Usage: python -m autogpt run [OPTIONS]
Sets up and runs an agent, based on the task specified by the user, or Sets up and runs an agent, based on the task specified by the user, or
@@ -105,13 +105,13 @@ Options:
<details> <details>
<summary> <summary>
<code>$ ./run.sh serve --help</code> <code>$ ./autogpt.sh serve --help</code>
</summary> </summary>
The `serve` sub-command starts AutoGPT wrapped in an Agent Protocol server: The `serve` sub-command starts AutoGPT wrapped in an Agent Protocol server:
```shell ```shell
$ ./run.sh serve --help $ ./autogpt.sh serve --help
Usage: python -m autogpt serve [OPTIONS] Usage: python -m autogpt serve [OPTIONS]
Starts an Agent Protocol compliant AutoGPT server, which creates a custom Starts an Agent Protocol compliant AutoGPT server, which creates a custom

View File

@@ -1,3 +0,0 @@
@echo off
set argument=--continuous
call run.bat %argument%

View File

@@ -1,3 +0,0 @@
#!/bin/bash
./run.sh --continuous $@

View File

@@ -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 8. _Optional: run `poetry install` to install all required dependencies._ The
application also checks for and installs any required dependencies when it starts. 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. See the [user guide](../usage.md) for further instructions.

View File

@@ -9,9 +9,9 @@ Activity, Error, and Debug logs are located in `./logs`
To print out debug logs: To print out debug logs:
```shell ```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 docker-compose run --rm auto-gpt --debug # in Docker
``` ```

View File

@@ -6,11 +6,11 @@
## Command Line Interface ## 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: sub-commands and arguments you can use:
```shell ```shell
$ ./run.sh --help $ ./autogpt.sh --help
Usage: python -m autogpt [OPTIONS] COMMAND [ARGS]... Usage: python -m autogpt [OPTIONS] COMMAND [ARGS]...
Options: Options:
@@ -22,7 +22,7 @@ Commands:
``` ```
!!! important "For Windows users" !!! 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. Everything else (subcommands, arguments) should work the same.
!!! info "Usage with Docker" !!! info "Usage with Docker"
@@ -40,11 +40,11 @@ The `run` sub-command starts AutoGPT with the legacy CLI interface.
<details> <details>
<summary> <summary>
<code>./run.sh run --help</code> <code>./autogpt.sh run --help</code>
</summary> </summary>
```shell ```shell
$ ./run.sh run --help $ ./autogpt.sh run --help
Usage: python -m autogpt run [OPTIONS] Usage: python -m autogpt run [OPTIONS]
Sets up and runs an agent, based on the task specified by the user, or 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 !!! note
For legacy reasons, the CLI will default to the `run` subcommand when none is 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. but this may change in the future.
#### 💀 Continuous Mode ⚠️ #### 💀 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. Use at your own risk.
```shell ```shell
./run.sh --continuous ./autogpt.sh --continuous
``` ```
To exit the program, press ++ctrl+c++ To exit the program, press ++ctrl+c++
@@ -119,11 +119,11 @@ frontend, by default on `http://localhost:8000`.
<details> <details>
<summary> <summary>
<code>./run.sh serve --help</code> <code>./autogpt.sh serve --help</code>
</summary> </summary>
```shell ```shell
$ ./run.sh serve --help $ ./autogpt.sh serve --help
Usage: python -m autogpt serve [OPTIONS] Usage: python -m autogpt serve [OPTIONS]
Starts an Agent Protocol compliant AutoGPT server, which creates a custom 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 * Run AutoGPT with a different AI Settings file
```shell ```shell
./run.sh --ai-settings <filename> ./autogpt.sh --ai-settings <filename>
``` ```
* Run AutoGPT with a different Prompt Settings file * Run AutoGPT with a different Prompt Settings file
```shell ```shell
./run.sh --prompt-settings <filename> ./autogpt.sh --prompt-settings <filename>
``` ```
!!! note !!! note
There are shorthands for some of these flags, for example `-P` for `--prompt-settings`. 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 [.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: To print out debug logs:
```shell ```shell
./run.sh --debug ./autogpt.sh --debug
``` ```
## Disabling Command Categories ## Disabling Command Categories