diff --git a/AGENTS.md b/AGENTS.md deleted file mode 100644 index 0a2bf3a..0000000 --- a/AGENTS.md +++ /dev/null @@ -1,57 +0,0 @@ -# Agent Context File - -## Your Mission - -Objective: Collaborate in the development of aiome-cli, a Rust-based command-line meta-agent. - -Core Idea: You are an AI coding agent. Your primary task is to help build the very tool that will orchestrate you and -your peers (@gpt, @claude, @gemini, @grok). The ultimate goal is to "dogfood" aiome-cli for its own development as -quickly as possible. - -Persona: Act as an expert Rust developer and a collaborative partner. Your code must be clean, idiomatic, and robust. -Your explanations should be direct and clear. - -Contribution Conventions: Prefix every proposed commit title and PR subject with the appropriate tag (e.g., `feat:`, -`fix:`, `refactor:`, `test:`, `doc:`) so the history stays consistent and scannable. - -## Project Vision: What We Are Building - -aiome-cli is a tool that allows users to interact with multiple AI models from a single command-line interface. The -primary interface is an interactive shell (REPL), designed for iterative development where users refine ideas across -multiple commands in a session. While one-shot invocations (e.g., `aiome "explain the config module"`) are supported, -the core workflow assumes a persistent interactive session. aiome-cli handles gathering context from the user's -environment, constructing the right prompt, and calling one or more agents asynchronously. - -Key Features: - -* Agent Targeting: User can call a default agent, a specific agent (@claude), or all agents (@all). -* Context Awareness: The tool must automatically package relevant context, such as file contents (-f foo.rs), git diff - output, or this very charter (AGENTS.md). -* Clear Output: Responses from different agents must be clearly attributed and formatted for readability in the - terminal. - -## Technical Specifications & Architecture - -You must adhere to the following technical stack and high-level design. - -* Language: Rust (2024 Edition) -* Core Dependencies: - - Async Runtime: tokio - - CLI Parsing: clap - - HTTP Client: reqwest - - Error Handling: anyhow - - Serialization: serde / serde_json - - Concurrency: futures -* Architectural Modules: - - main.rs: Entry point, argument parsing. - - config.rs: Manages API keys and user settings from ~/.config/aiome/config.toml. - - agents/: Contains a module for each agent, implementing a common Agent trait. - - context.rs: Gathers context (files, git status, agent charters like this one). - - dispatcher.rs: Constructs the final prompt and dispatches it to the appropriate agent(s). - - ui.rs: Formats and prints the output to the console. - -## Your First Task - -The first milestone is to bootstrap a minimal viable version of aiome-cli. This version should be able to parse a -simple prompt, call a single hard-coded agent API (e.g., GPT), and print the response. This will establish the core -loop of the application. Subsequent tasks will build upon this foundation. diff --git a/CLAUDE.md b/CLAUDE.md deleted file mode 100644 index 131007f..0000000 --- a/CLAUDE.md +++ /dev/null @@ -1,7 +0,0 @@ -# CLAUDE.md - -See [AGENTS.md](AGENTS.md) for agent context file. - -## Project Context - -- **Rust Edition**: This project uses Rust 2024 Edition, which has already been released. diff --git a/GEMINI.md b/GEMINI.md deleted file mode 100644 index cb433d7..0000000 --- a/GEMINI.md +++ /dev/null @@ -1,3 +0,0 @@ -# Gemini Context File - -See [AGENTS.md](AGENTS.md) for agent context file. diff --git a/HUMANS.md b/HUMANS.md new file mode 100644 index 0000000..5482913 --- /dev/null +++ b/HUMANS.md @@ -0,0 +1,39 @@ +# Aiome: For Human Readers + +Welcome. This document is for humans who want a quick, honest overview. + +## What is Aiome? + +Aiome is an early-stage CLI exploring how multiple AI agents could collaborate on software work. The long-term vision is +role-based agents coordinating through artifacts like code, tests, and issues. The current reality is much smaller. + +## Current State + +Right now the CLI is a simple REPL that echoes input. That’s it. Anything beyond that is a direction, not a promise. + +## Why It Exists + +We want to see if a small set of lightweight principles can help AI agents do useful work without heavy process. We +expect the project structure to evolve based on real usage. + +## Quick Start (Today) + +```bash +# Run locally +cargo run + +# Or install locally +cargo install --path . +``` + +This starts a prompt. Type a line, it echoes back. Use Ctrl+D (Unix/Linux/macOS) or Ctrl+Z then Enter (Windows) to exit. + +## Where to Look Next + +- **README.md**: Direction for agents and contributors +- **src/main.rs**: The current CLI entry point + +## The Name + +"Aiome" = AI + microbiome. Like gut bacteria, AI agents form a symbiotic ecosystem with their human host. You didn’t +create them, you don’t fully control them, but you’re better together. diff --git a/README.md b/README.md index 7af3ecb..f619a01 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,72 @@ -# aiome-cli +# Aiome -Interactive CLI to orchestrate AI coding agents. +> **Human readers**: See [HUMANS.md](./HUMANS.md) for a gentler introduction. + +Aiome is an early-stage CLI exploring how multiple AI agents can collaborate on software work. This README is +intentionally lightweight: it sets direction without pretending the project is further along than it is. + +--- + +## Current State (Reality Wins) + +Right now this repository is small and experimental. The CLI is a simple REPL that echoes input. Anything beyond that is +directional, not guaranteed. + +If this document drifts from the code, update the document. + +--- + +## Direction (Not Mandates) + +These are the ideas we want to grow toward, without locking ourselves into a rigid process: + +- **Roles are verbs.** Treat agents as functions, not personas. +- **Bounded work.** Keep scope small, context limited, and changes reversible. +- **Coordination via artifacts.** Prefer code, tests, issues, and notes over chatty handoffs. +- **Transparency.** If you’re unsure, say so and leave a clear trail. +- **Locality.** Touch what you must, avoid sweeping refactors. + +--- + +## Potential Roles (Names May Change) + +These are placeholders for how we might structure work over time: + +- **plan** — identify work worth doing +- **implement** — make a focused change +- **review** — check correctness and scope +- **debug** — fix a concrete issue +- **refactor** — improve structure without behavior changes +- **retrospect** — reflect and propose process tweaks + +Treat these as a vocabulary, not a contract. + +--- + +## Working Here (Lightweight) + +- Prefer small, readable changes over perfect systems. +- If you add tests, run `cargo test`. If you add formatting or linting conventions, document them. +- If you want to introduce new process or guardrails, open an issue first so humans can weigh in. + +--- + +## Repository Snapshot (Today) + +This is the current layout and may evolve: + +``` +repo-root/ +├── Cargo.toml +├── src/ +│ └── main.rs +├── HUMANS.md +└── README.md +``` + +--- + +## Final Note + +Let the structure emerge from the work. Keep the docs honest. Make it easy for the next person to understand what +changed and why.