Auto-GPT/docs/usage.md

Usage

Command Line Arguments

Running with --help lists all the possible command line arguments you can pass:

./run.sh --help     # on Linux / macOS

.\run.bat --help    # on Windows

!!! info For use with Docker, replace the script in the examples with docker-compose run --rm auto-gpt:

    :::shell
    docker-compose run --rm auto-gpt --help
    docker-compose run --rm auto-gpt --ai-settings <filename>

!!! note Replace anything in angled brackets (<>) to a value you want to specify

Here are some common arguments you can use when running Auto-GPT:

• Run Auto-GPT with a different AI Settings file

    :::shell
    ./run.sh --ai-settings <filename>
  

• Specify a memory backend

    :::shell
    ./run.sh --use-memory  <memory-backend>
  

!!! note There are shorthands for some of these flags, for example -m for --use-memory.
Use ./run.sh --help for more information.

Speak Mode

Enter this command to use TTS (Text-to-Speech) for Auto-GPT

./run.sh --speak

💀 Continuous Mode ⚠️

Run the AI without user authorization, 100% automated. Continuous mode is NOT recommended. It is potentially dangerous and may cause your AI to run forever or carry out actions you would not usually authorize. Use at your own risk.

./run.sh --continuous

To exit the program, press ++ctrl+c++

♻️ Self-Feedback Mode ⚠️

Running Self-Feedback will INCREASE token use and thus cost more. This feature enables the agent to provide self-feedback by verifying its own actions and checking if they align with its current goals. If not, it will provide better feedback for the next loop. To enable this feature for the current loop, input S into the input field.

GPT-3.5 ONLY Mode

If you don't have access to GPT-4, this mode allows you to use Auto-GPT!

./run.sh --gpt3only

You can achieve the same by setting SMART_LLM_MODEL in .env to gpt-3.5-turbo.

GPT-4 ONLY Mode

If you have access to GPT-4, this mode allows you to use Auto-GPT solely with GPT-4. This may give your bot increased intelligence.

./run.sh --gpt4only

!!! warning Since GPT-4 is more expensive to use, running Auto-GPT in GPT-4-only mode will increase your API costs.

Logs

Activity and error logs are located in the ./output/logs

To print out debug logs:

./run.sh --debug

Disabling Command Categories

If you want to selectively disable some command groups, you can use the DISABLED_COMMAND_CATEGORIES config in your .env. You can find the list of categories in your .env.template

For example, to disable coding related features, set it to the value below:

DISABLED_COMMAND_CATEGORIES=autogpt.commands.analyze_code,autogpt.commands.execute_code,autogpt.commands.git_operations,autogpt.commands.improve_code,autogpt.commands.write_tests