Skip to content

INSTALL_OR_USE.md

Latest commit

 

History

History
executable file
·
60 lines (48 loc) · 3.49 KB

INSTALL_OR_USE.md

File metadata and controls

executable file
·
60 lines (48 loc) · 3.49 KB

AI_CORE: Installation and Usage Guide

Which Version Should I Use?

  • V0: For simple, folder-based context tracking with minimal setup.
  • V1: If you want explicit task tracking and FSM-guided workflow.
  • V2: For advanced context, modular directives, and Atom of Thought reasoning.
  • V3: For self-modifying, self-improving systems with multi-perspective vetting.

Note on .ai_core

The .ai_core directory and its subfolders may be empty until you or the system add directives, memory, tools, or logs. This is expected for new setups.

This guide explains how to put AI_CORE into use, especially in conjunction with modern IDEs like Cursor or VSCode. It focuses on leveraging the core prompts and versioned configuration files to set up your environment for contextual, AI-driven workflows.

1. Clone the Repository

Clone the AI_CORE repository to your local machine:

git clone <your-repo-url>
cd AI_CORE

2. Choose Your Version

Navigate to the Versions/ directory and review the available versions (V0, V1, V2, V3). Each version introduces new features and workflow enhancements. Select the version that best fits your needs.

3. Using Core Prompts with Your IDE

For Cursor (Custom Mode Example)

  1. Open Cursor.
  2. Navigate to the Custom Mode or Prompt Area.
  3. Copy the relevant V#_README.md file (e.g., V3_README.md) from the Versions/ directory.
  4. Paste the contents into the custom mode prompt.
  5. Instruct the system:
    • Example: "Set yourself up or sync according to the configuration files and directives described in this README. Prepare to work using the specified workflow and context."
  6. (Optional) Reference Additional Files:
    • If your version uses TASKS.md, FSM.md, or other supporting files, you may also copy their contents into the prompt or upload them as context.

For Other IDEs (VSCode, etc.)

  • Use the README and supporting files as reference for your workflow.
  • If your IDE supports custom prompts, context windows, or extensions, load the relevant version’s README and configuration files as context.

4. Setting Up the .ai_core Directory (V2+)

If you are using V2 or later:

  • Ensure the .ai_core directory exists at the project root.
  • Populate core_directives/, core_contextual_memory/, core_toolbox/, and core_history/ as needed.
  • Use the prompts and configuration files to guide the AI/IDE in managing and updating these resources.

5. Keeping in Sync

  • Whenever you update your configuration or directives, repeat the process: copy the latest README and supporting files into your IDE’s prompt area and instruct the system to sync or reconfigure.
  • For collaborative teams, ensure everyone is using the same version and configuration files.

6. Example Prompt for Initialization

You are now operating in AI_CORE V3 mode. Please read the following configuration and set yourself up according to the described workflow, directives, and context. Use the supporting TASKS.md and FSM.md files as needed. Sync your state and get ready to work.

7. Troubleshooting

  • If the AI/IDE does not respond as expected, double-check that you have pasted the correct version’s README and supporting files.
  • Ensure the .ai_core directory and its subfolders are present for V2+.
  • Review the version documentation in the Versions/ directory for additional setup details.

For more information, see the README.md and the documentation in the Versions/ directory.