Skip to content

Latest commit

 

History

History
224 lines (165 loc) · 7.32 KB

README.md

File metadata and controls

224 lines (165 loc) · 7.32 KB

Autonomys Agents Banner_1

Autonomys Agents: A framework for building autonomous AI agents

Autonomys Agents is an EXPERIMENTAL framework for building AI agents. Currently, the framework supports agents that can interact with social networks and maintain permanent memory through the Autonomys Network. We are still in the EARLY STAGES OF DEVELOPMENT and are actively seeking feedback and contributions. We will be rapidly adding many more workflows and features.

Features

  • 🤖 Autonomous social media engagement
  • 🧠 Permanent agent memory storage via Autonomys Network
  • 🔄 Built-in orchestration system
  • 🐦 Twitter integration (with more platforms planned)
  • 🎭 Customizable agent personalities
  • 🛠️ Extensible tool system

Getting Started

  1. Install dependencies: yarn install
  2. Create your character config: yarn create-character <your-character-name>
  3. Setup character config:
    • All character configs are stored in characters/{your-character-name}/config
    • Update .env with applicable environment variables
    • Update config.yaml with applicable configuration
    • Update {your-character-name}.yaml with applicable personality configuration (See Character System below).
  4. Run your character:
    • For dev purposes in watch mode: yarn dev <your-character-name>
    • For production build and run: yarn start <your-character-name>
    • For interactive CLI interface: yarn cli <your-character-name>

Interactive CLI Interface

The framework includes an interactive terminal-based UI for managing and monitoring your AI agent. To start the interface:

yarn cli <your-character-name>

Features:

  • Real-time character status and workflow monitoring
  • Interactive command input with keyboard shortcuts
  • Task scheduling and management
  • Live output logging

Keyboard Shortcuts:

  • Enter: Send message/command
  • Ctrl+n: Insert new line in input
  • Ctrl+i: Focus input box
  • Ctrl+b/Ctrl+f: Scroll output log by page
  • Ctrl+p/Ctrl+n: Scroll output log by line
  • Escape/q/Ctrl+C: Quit

The interface provides a user-friendly way to interact with your agent, monitor its activities, and manage scheduled tasks, all within a terminal environment.

Examples

The following examples demonstrate the use of the framework and are available:

Character System

The framework uses a YAML-based character system that allows you to create and run different AI personalities.

Creating Characters

  1. Character related files are stored in characters/{your-character-name}/

  2. Create new characters by running the create-character.ts script:

    # Create a new character
yarn create-character your_character

Character Configuration

Each character file is a YAML configuration with the following structure:

name: 'Agent Name'

description: |
  Core personality description
  Can span multiple lines

personality:
  - Key behavioral trait 1
  - Key behavioral trait 2

expertise:
  - Area of knowledge 1
  - Area of knowledge 2

communication_rules:
  rules:
    - Operating guideline 1
    - Operating guideline 2
  words_to_avoid:
    - word1
    - word2

twitter_profile:
  username: 'twitter_handle'
  trend_focus:
    - Topic to monitor 1
    - Topic to monitor 2

  content_focus:
    - Content guideline 1
    - Content guideline 2

  reply_style:
    - Engagement approach 1
    - Engagement approach 2

  engagement_criteria:
    - Engagement rule 1
    - Engagement rule 2

Example Characters

  1. Joy Builder (joy_builder.yaml):

    name: 'Joy Builder'
username: 'buildjoy'
description: |
  Joy Builder is an AI agent who is relentlessly optimistic about technology's potential to solve human problems.
  The Joy represents their positive outlook, while Builder reflects their focus on practical solutions and progress.

expertise:
  - Software development and system architecture
  - Open source and collaborative technologies
  - Developer tools and productivity
# ... other configuration

  2. Tech Analyst (tech_analyst.yaml):

    name: 'Tech Analyst'
username: 'techanalyst'
description: |
  A thoughtful technology analyst focused on emerging trends.
  Provides balanced perspectives on technological developments.

expertise:
  - AI and blockchain technology
  - Web3 and the future of the internet
  - Technical analysis and research
# ... other configuration

Context Size Management

The orchestrator helps manage the LLM's context window size through pruning parameters. These parameters control message summarization and retention. Configure them in two ways:

  1. Dynamic configuration when creating the orchestrator: 
    const runner = await getOrchestratorRunner({
  model,                   // model to use for the agent
  prompts,                 // prompts for the agent
  tools,                   // tools available to the agent
  namespace,               // name of the agent
  vectorStore,             // vector store for the agent
  pruningParameters: PruningParameters{
    maxWindowSummary: 10,  // End index for message slice
    maxQueueSize: 50       // Trigger summarization threshold
  }
});

When messages exceed maxQueueSize, a summary is created. The new state will contain: the original first message, the new summary message, and all messages from index maxWindowSummary onwards from the previous state.

Autonomys Network Integration

The framework uses the Autonomys Network for permanent storage of agent memory and interactions. This enables:

  • Persistent agent memory across sessions
  • Verifiable interaction history
  • Cross-agent memory sharing
  • Decentralized agent identity

To use this feature:

  1. Configure your AUTO_DRIVE_API_KEY in .env (obtain from https://ai3.storage)
  2. Enable Auto Drive uploading in config.yaml
  3. Provide your Taurus EVM wallet details (PRIVATE_KEY) and Agent Memory Contract Address (CONTRACT_ADDRESS) in .env`
  4. Make sure your Taurus EVM wallet has funds. A faucet can be found at https://subspacefaucet.com/
  5. Provide encryption password in .env (optional, leave empty to not encrypt the agent memories)

Resurrection

To resurrect memories from the Autonomys Network, run the following command:

Options

  • -o, --output: (Optional) The directory where memories will be saved. Defaults to ./memories
  • -n, --number: (Optional) Number of memories to fetch. If not specified, fetches all memories
  • --help: Show help menu with all available options

Examples:

yarn resurrect your_character_name                                  # Fetch all memories to ./memories/
yarn resurrect your_character_name -n 1000                           # Fetch 1000 memories to ./memories/
yarn resurrect your_character_name -o ./memories/my-agent -n 1000    # Fetch 1000 memories to specified directory
yarn resurrect your_character_name --output ./custom/path            # Fetch all memories to custom directory
yarn resurrect --help                            # Show help menu

Testing

To run tests:

yarn test

License

MIT