aljaz/Auto-GPT
1
0
Fork 0
mirror of https://github.com/aljazceru/Auto-GPT.git synced 2025-12-18 14:34:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor: Rename Agent's entrypoint to autogpt.sh

Browse Source 
- 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
Download Patch File Download Diff File Expand all files Collapse all files

10
autogpts/autogpt/README.md
View File

@@ -34,7 +34,7 @@ see the [setup guide][docs/setup].
## Running AutoGPT
The CLI should be self-documenting:
```shell
$ ./run.sh --help
$ ./autogpt.sh --help
Usage: python -m autogpt [OPTIONS] COMMAND [ARGS]...
Options:
@@ -48,13 +48,13 @@ When run without a sub-command, it will default to `run` for legacy reasons.
<details>
<summary>
<code>$ ./run.sh run --help</code>
<code>$ ./autogpt.sh run --help</code>
</summary>
The `run` sub-command starts AutoGPT with the legacy CLI interface:
```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
@@ -105,13 +105,13 @@ Options:
<details>
<summary>
<code>$ ./run.sh serve --help</code>
<code>$ ./autogpt.sh serve --help</code>
</summary>
The `serve` sub-command starts AutoGPT wrapped in an Agent Protocol server:
```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

0
autogpts/autogpt/run.bat → autogpts/autogpt/autogpt.bat
View File

0
autogpts/autogpt/run.sh → autogpts/autogpt/autogpt.sh
View File

3
autogpts/autogpt/run_continuous.bat
View File

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

3
autogpts/autogpt/run_continuous.sh
View File

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

2
docs/content/AutoGPT/setup/index.md
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
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.

4
docs/content/AutoGPT/share-your-logs.md
View File

@@ -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
```

26
docs/content/AutoGPT/usage.md
View File

@@ -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.
<details>
<summary>
<code>./run.sh run --help</code>
<code>./autogpt.sh run --help</code>
</summary>
```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`.
<details>
<summary>
<code>./run.sh serve --help</code>
<code>./autogpt.sh serve --help</code>
</summary>
```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 <filename>
./autogpt.sh --ai-settings <filename>
```
* Run AutoGPT with a different Prompt Settings file
```shell
./run.sh --prompt-settings <filename>
./autogpt.sh --prompt-settings <filename>
```
!!! 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