Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add instruction to show .env #2705

Merged
merged 2 commits into from
Apr 21, 2023
Merged

add instruction to show .env #2705

merged 2 commits into from
Apr 21, 2023

Conversation

itsmarble
Copy link
Contributor

Background

This pull request aims to improve the user experience when configuring API keys in the Auto-GPT project. The changes include clear instructions for accessing hidden files (.env.template) in various operating systems and explaining the rationale behind hiding the file.

Changes

  • Updated the configuration instructions to explain how to reveal hidden files in different operating systems.

    Locate the file named .env.template in the main /Auto-GPT folder. This file may be hidden by default in some operating systems due to the dot prefix. To reveal hidden files, follow the instructions for your specific operating system (e.g., in Windows, click on the "View" tab in File Explorer and check the "Hidden items" box; in macOS, press Cmd + Shift + .).

Documentation

The updated instructions are included in the README.md file and the project's main documentation.

Test Plan

PR Quality Checklist

  • My pull request is atomic and focuses on a single change.
  • I have thoroughly tested my changes with multiple different prompts.
  • I have considered potential risks and mitigations for my changes.
  • I have documented my changes clearly and comprehensively.
  • I have not snuck in any "extra" small tweaks changes

@itsmarble itsmarble mentioned this pull request Apr 20, 2023
Closed
@k-boikov k-boikov added the documentation Improvements or additions to documentation label Apr 20, 2023
@richbeales richbeales merged commit 1b5743d into Significant-Gravitas:master Apr 21, 2023
yoitzme added a commit to yoitzme/Auto-GPT that referenced this pull request Apr 21, 2023
@yoitzme
Squashed commit of the following:
8b1da05 
commit e275fd1
Author: Irmantas Neciunskas <[email protected]>
Date:   Fri Apr 21 17:21:57 2023 +0300

    fix docker-compose.yml to attach proper workspace
    make changes to work docker with mac m1 chip browse_website command as chromium drivers is crashing and need to use firefox.
    Update README.md

commit 6c5d21c
Author: coditamar <[email protected]>
Date:   Fri Apr 21 13:24:26 2023 +0300

    config.py: make load_dotenv(override=True) (Significant-Gravitas#2788)

commit 4eaec80
Merge: 7b22809 ae7b81d
Author: Richard Beales <[email protected]>
Date:   Fri Apr 21 06:17:51 2023 +0100

    Merge pull request Significant-Gravitas#2313 from lengweiping1983/arg_config_optimization

    only adjust argument order

commit 7b22809
Merge: d573bee ec945d1
Author: Richard Beales <[email protected]>
Date:   Fri Apr 21 06:14:05 2023 +0100

    Merge pull request Significant-Gravitas#2545 from cryptidv/fixes

    Added version select to bug template

commit d573bee
Merge: 781f293 9f6d6f3
Author: Richard Beales <[email protected]>
Date:   Fri Apr 21 06:07:12 2023 +0100

    Merge pull request Significant-Gravitas#2651 from riensen/patch-1

    Improve plugin section in README.md to prevent dependency errors

commit 781f293
Merge: 1b5743d 37c5ebf
Author: Richard Beales <[email protected]>
Date:   Fri Apr 21 06:00:59 2023 +0100

    Merge pull request Significant-Gravitas#2682 from AndresCdo/update-pre-commit-version

    Update pre-commit version

commit 1b5743d
Merge: 26ee15d e006a61
Author: Richard Beales <[email protected]>
Date:   Fri Apr 21 05:59:48 2023 +0100

    Merge pull request Significant-Gravitas#2705 from itsmarble/add_show_env_fiile_instruct

    add instruction to show .env

commit 26ee15d
Merge: 78bddf3 25db6e5
Author: Richard Beales <[email protected]>
Date:   Fri Apr 21 05:54:09 2023 +0100

    Merge pull request Significant-Gravitas#2709 from Bsodoge/fix-typo

    Update README.md

commit 78bddf3
Merge: de1ea5f 6b7787c
Author: Richard Beales <[email protected]>
Date:   Fri Apr 21 05:51:11 2023 +0100

    Merge pull request Significant-Gravitas#2752 from chrisvxd/patch-1

    docs: fix small typo in README

commit de1ea5f
Merge: d5162d3 b49ef91
Author: Richard Beales <[email protected]>
Date:   Fri Apr 21 05:48:09 2023 +0100

    Merge pull request Significant-Gravitas#2758 from Pwuts/fix/silent-azure-fail

    Make `load_azure_config` throw if `azure.yaml` does not exist

commit d5162d3
Merge: 63c2182 5155056
Author: Richard Beales <[email protected]>
Date:   Fri Apr 21 05:46:01 2023 +0100

    Merge pull request Significant-Gravitas#2628 from ntindle/ci/coverage-reporting

    Add Coverage reporting to CI pipeline

commit 63c2182
Author: lengweiping1983 <[email protected]>
Date:   Fri Apr 21 12:09:17 2023 +0800

    Fix typo's (Significant-Gravitas#2735)

    Co-authored-by: lengweiping <[email protected]>

commit b49ef91
Author: Reinier van der Leer <[email protected]>
Date:   Fri Apr 21 05:15:39 2023 +0200

    Make `load_azure_config` throw if `azure.yaml` does not exist

commit ec27d57
Author: Nick Foster <[email protected]>
Date:   Thu Apr 20 21:55:20 2023 -0500

    Fix label of `download_file` command (Significant-Gravitas#2753)

    Co-authored-by: Reinier van der Leer <[email protected]>

commit 6b7787c
Author: Chris Villa <[email protected]>
Date:   Fri Apr 21 14:19:00 2023 +1200

    docs: fix small typo in README

commit 5580037
Author: Andres Caicedo <[email protected]>
Date:   Fri Apr 21 04:00:44 2023 +0200

    Add missing `size` param to generate_image_with_dalle (Significant-Gravitas#2691)

commit 00ecb98
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 13:56:59 2023 +1200

    Update README.md

commit f265411
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 13:53:31 2023 +1200

    Update README.md

commit 1e3bcc3
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 12:52:22 2023 +1200

    Update README.md

commit 8faf4f5
Author: Torantulino <[email protected]>
Date:   Fri Apr 21 00:40:07 2023 +0000

    Deploying to master from @ Significant-Gravitas/AutoGPT@48f4119 🚀

commit 48f4119
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 12:38:18 2023 +1200

    Update sponsors_readme.yml

commit ad6f18b
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 12:31:37 2023 +1200

    Update sponsors_readme.yml

commit 68e479b
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 12:26:04 2023 +1200

    Update sponsors_readme.yml

commit 1dd8e57
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 12:24:18 2023 +1200

    Update sponsors_readme.yml

commit 511b021
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 12:22:32 2023 +1200

    Update sponsors_readme.yml

commit 121e08c
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 12:19:30 2023 +1200

    Create sponsors_readme.yml

commit 785c90d
Author: Toran Bruce Richards <[email protected]>
Date:   Fri Apr 21 12:19:20 2023 +1200

    Remove hardcoded sponsors

commit d9d5fd5
Merge: 14d3eca c145d95
Author: BillSchumacher <[email protected]>
Date:   Thu Apr 20 17:40:25 2023 -0500

    Merge pull request Significant-Gravitas#2727 from Pwuts/fix/spacy-install-model

    fix Significant-Gravitas#2654 spacy language model installation

commit c145d95
Author: Reinier van der Leer <[email protected]>
Date:   Thu Apr 20 23:53:06 2023 +0200

    Fix Significant-Gravitas#2654 spacy language model installation

commit 37c5ebf
Merge: 3871fc7 14d3eca
Author: Andres Caicedo <[email protected]>
Date:   Thu Apr 20 20:16:09 2023 +0200

    Merge remote-tracking branch 'upstream/master' into update-pre-commit-version

commit 14d3eca
Author: Peter Banda <[email protected]>
Date:   Thu Apr 20 19:51:52 2023 +0200

    Pin BeautifulSoup version to fix `browse_website` (Significant-Gravitas#2680)

commit 25db6e5
Author: Bsodoge <[email protected]>
Date:   Thu Apr 20 18:49:15 2023 +0100

    Fix typo

commit e006a61
Author: itsmarble <[email protected]>
Date:   Thu Apr 20 19:42:48 2023 +0200

    hotfix

commit 5ecb08c
Author: itsmarble <[email protected]>
Date:   Thu Apr 20 19:26:55 2023 +0200

    add instruction to show .env

commit 0bf4987
Merge: 4c686f8 9b78e71
Author: Richard Beales <[email protected]>
Date:   Thu Apr 20 18:19:52 2023 +0100

    Merge pull request Significant-Gravitas#2644 from riensen/rename-whitelist

    Use inclusive language: Rename 'blacklist' to 'denylist' and 'whitelist' to 'allowlist'

commit 3871fc7
Merge: 3de7325 4c686f8
Author: Andres Caicedo <[email protected]>
Date:   Thu Apr 20 19:01:25 2023 +0200

    Merge remote-tracking branch 'upstream/master' into update-pre-commit-version

commit 9b78e71
Author: riensen <[email protected]>
Date:   Thu Apr 20 10:46:21 2023 +0200

    Use allowlist and denylist naming

commit 4c686f8
Merge: cf7544c c09ed61
Author: Richard Beales <[email protected]>
Date:   Thu Apr 20 17:47:47 2023 +0100

    Merge pull request Significant-Gravitas#2667 from egonm12/update-readme-git-clone-command

    doc: update git clone command to use stable branch

commit 3de7325
Merge: 6699a8e bb7ca69
Author: Andres Caicedo <[email protected]>
Date:   Thu Apr 20 18:22:14 2023 +0200

    Merge remote-tracking branch 'upstream/master' into update-pre-commit-version

commit cf7544c
Author: Eddie Cohen <[email protected]>
Date:   Thu Apr 20 12:09:20 2023 -0400

    Cancel in-progress docker CI on outdate (Significant-Gravitas#2619)

    Co-authored-by: Reinier van der Leer <[email protected]>

commit 2a20ea6
Author: Jartto <[email protected]>
Date:   Fri Apr 21 00:07:53 2023 +0800

    Fix README `./run.sh start` -> `./run.sh` (Significant-Gravitas#2523)

    Co-authored-by: Reinier van der Leer <[email protected]>

commit 6699a8e
Author: Andres Caicedo <[email protected]>
Date:   Thu Apr 20 16:49:11 2023 +0200

    Update .pre-commit-config.yaml

    Update pre-commit-hooks to latest version v4.4.0

commit bb7ca69
Author: k-boikov <[email protected]>
Date:   Thu Apr 20 15:45:26 2023 +0300

    include openapi-python-client in docker build (Significant-Gravitas#2669)

    Fixes Significant-Gravitas#2658 "Docker image crashes on start"

commit c09ed61
Author: Egon Meijers <[email protected]>
Date:   Thu Apr 20 14:22:24 2023 +0200

    doc: update git clone command to use stable branch

    Since master should not be used for installation as described in the readme, it would be better to checkout the stable branch immediately when cloning to prevent people from reporting issues that are not in the stable environment.

commit 9f6d6f3
Author: riensen <[email protected]>
Date:   Thu Apr 20 11:17:47 2023 +0200

    Update plugin instructions and improve clarity

commit 5155056
Author: Nicholas Tindle <[email protected]>
Date:   Thu Apr 20 00:25:48 2023 -0500

    feat: permissions

commit 9cb4739
Author: Nicholas Tindle <[email protected]>
Date:   Thu Apr 20 00:22:10 2023 -0500

    fix: syntax

commit b9623ed
Author: Nicholas Tindle <[email protected]>
Date:   Thu Apr 20 00:21:20 2023 -0500

    fix: add new line back

commit 7c45b21
Author: Nicholas Tindle <[email protected]>
Date:   Thu Apr 20 00:11:43 2023 -0500

    Update ci.yml

commit ec945d1
Author: Eesa Hamza <[email protected]>
Date:   Wed Apr 19 17:59:17 2023 +0300

    Fixed links

commit 9240a55
Author: Eesa Hamza <[email protected]>
Date:   Wed Apr 19 17:55:36 2023 +0300

    Added version select to bug template

commit ae7b81d
Merge: 09e29f1 89539d0
Author: lengweiping1983 <[email protected]>
Date:   Wed Apr 19 06:48:31 2023 +0800

    Merge branch 'master' into arg_config_optimization

commit 09e29f1
Merge: 275b2ea fd4a2ed
Author: lengweiping <[email protected]>
Date:   Tue Apr 18 23:37:17 2023 +0800

    fix conflicts

commit 275b2ea
Author: lengweiping <[email protected]>
Date:   Tue Apr 18 13:06:09 2023 +0800

    only adjust the order,  so argument definitions are consistent with the logical order
@itsmarble itsmarble deleted the add_show_env_fiile_instruct branch May 3, 2023 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@richbeales richbeales richbeales approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation size/xs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@itsmarble @richbeales @k-boikov