diff --git a/README-jp.md b/README-jp.md index e4df19fc..780714c5 100644 --- a/README-jp.md +++ b/README-jp.md @@ -69,9 +69,7 @@ https://x.com/saten_work/status/1791558481432232355 2. ```cd```でBabyCommandAGIのディレクトリに入ってくださ 3. ```cp .env.example .env``` で環境変数を入れるファイルを作ります 4. OPENAI_API_KEYにOpenAIキーを設定します。 -5. RESULTS_STORE_NAME 変数にタスクの結果を保存するテーブルの名前を設定します。 -6. （オプション）OBJECTIVE変数にタスク管理システムの目的を設定します。 -7. （オプション）INITIAL_TASK 変数に、システムの最初のタスクを設定します。 +5. （オプション）OBJECTIVE変数にタスク管理システムの目的を設定します。 # 実行(Docker) @@ -93,18 +91,14 @@ docker-compose up -d && docker attach babyagi OBJECTIVEを変更すると将来のタスク一覧とOBJECTIVEのフィードバックがクリアされます。 -以下にそれぞれ途中まで実行された状態が保存されます。 -- ```data```フォルダ配下に途中まで実行されたタスクは保存されています。 -- ```pwd```フォルダ配下には最後のカレントディレクトリ -- ```env_dump```フォルダ配下には最後の環境変数のdump - -環境をリセットしたい場合はBabyCommandAGIのDockerのコンテナを一度削除して、```.env```のRESULTS_STORE_NAMEを変更してください。 -(BabyCommandAGIは様々なコマンドを実行するので環境が壊れることがあります) - ## AIにフィードバック "f"を入力した際にちゃんと目的が達成できたかユーザーのフィードバックをAIに与えられます。これでGUIのようなCLIからわからない情報もAIにフィードバックできます。 +## AIのコマンド実行中に入力 + +通常時はAIが実行しているコマンドに対してyやnの応答はできませんが、"c"を入力すると応答できるモードになります。 + # 便利コマンド - ```./clean.sh``` @@ -120,6 +114,13 @@ BabyCommandAGIのデータ(覚えている情報)を新しくします。新し 実行時のログが```log```フォルダ配下に残るようになっています。 OBJECTIVEの識別子とRESULTS_STORE_NAMEによりログファイル名は決まります。 +# 保存データ + +以下にそれぞれ途中まで実行された状態が保存されます。 +- ```data```フォルダ配下に途中まで実行されたタスクは保存されています。 +- ```pwd```フォルダ配下には最後のカレントディレクトリ +- ```env_dump```フォルダ配下には最後の環境変数のdump + # コントリビュート BabyCommandAGI はまだ初期段階にあり、その方向性とそこに到達するためのステップを決定しているところです。現在、BabyCommandAGI が目指しているのは、「シンプル」であることです。このシンプルさを維持するために、PR を提出する際には、以下のガイドラインを遵守していただくようお願いいたします: diff --git a/README.md b/README.md index 1a8d1ee5..916d64bc 100644 --- a/README.md +++ b/README.md @@ -69,9 +69,7 @@ Please follow the steps below: 2. Enter the BabyCommandAGI directory with ```cd```. 3. Create a file to insert environment variables with ```cp .env.example .env```. 4. Set the OpenAI key to OPENAI_API_KEY. -5. Set the name of the table where the task results are saved to the TABLE_NAME variable. -6. (Optional) Set the objective of the task management system to the OBJECTIVE variable. -7. (Optional) Set the system's first task to the INITIAL_TASK variable. +5. (Optional) Set the objective of the task management system to the OBJECTIVE variable. # Execution (Docker) @@ -93,18 +91,14 @@ If you fail, you can resume from where you left off by running it again. Changing the OBJECTIVE will clear the list of future tasks and OBJECTIVE feedback. -The following are saved up to the point where they were executed: -- Tasks executed up to a certain point are saved under the ```data``` folder. -- The last current directory is under the ```pwd``` folder. -- The dump of the last environment variables is under the ```env_dump``` folder. - -If you want to reset the environment, please delete the Docker container of BabyCommandAGI once and change the RESULTS_STORE_NAME in ```.env```. -(BabyCommandAGI executes various commands, so the environment may be broken) - ## Feedback to AI By entering "f", you can give user feedback to the AI. This allows you to provide feedback to the AI on information that may not be clear from the CLI, like a GUI. +## Input while AI is executing a command + +Normally, you cannot respond with y or n to a command that AI is executing, but entering "c" will put you in a mode where you can respond. + # Useful commands - ```. /clean.sh``` @@ -120,6 +114,13 @@ New BabyCommandAGI data (remembered information) will be created. Because of the The logs during execution are saved under the ```log``` folder. The log file name is determined by the OBJECTIVE identifier and the RESULTS_STORE_NAME. +# Saved Data + +The following are saved up to the point where they were executed: +- Tasks executed up to a certain point are saved under the ```data``` folder. +- The last current directory is under the ```pwd``` folder. +- The dump of the last environment variables is under the ```env_dump``` folder. + # Contributing BabyCommandAGI is still in the early stages, determining its direction and the steps to get there. Currently, BabyCommandAGI is aiming for simplicity. To maintain this simplicity, when submitting PRs, we kindly ask you to follow the guidelines below: