Getting Started with ayaiay
This guide will help you get up and running with ayaiay in just a few minutes.
Choose Your Tool
ayaiay offers three main tools, each designed for different use cases:
š¦ ayaiay Catalog (Web)
Best for: Browsing, discovering, and exploring packs visually
The catalog is a web platform where you can:
- Browse all available packs
- Search for specific agents, instructions, or prompts
- View detailed documentation and examples
- Manage your own published packs
š Visit the Catalog or read the Catalog Guide
š» ayaiay CLI (Command Line)
Best for: Installing and managing packs locally, automation
The CLI is a command-line tool that lets you:
- Search for packs from your terminal
- Install packs into your local environment
- Validate pack manifests
- Manage pack versions
š Install the CLI or read the CLI Guide
š ayaiay MCP (.NET MCP Server)
Best for: Programmatic integration with MCP-compatible tools
The MCP server provides:
- All CLI functionality through the Model Context Protocol
- Seamless integration with Claude Desktop, Cline, and other MCP clients
- Tool discovery and execution
- Resource management
š Setup ayaiay MCP or read the MCP Guide
Quick Start: Using the Catalog (Web)
- Visit the catalog: Go to https://ayaiay.org
- Browse or search: Use the search bar or browse categories
- View pack details: Click on any pack to see its contents
- Use the resources: View agents, instructions, prompts, and MCP servers
No installation required! The catalog is accessible from any web browser.
Quick Start: Using the CLI
Prerequisites
- Python 3.8 or higher
- pip (Python package manager)
Installation
# Install via pip
pip install ayaiay-cli
# Verify installation
ayaiay --version
Basic Usage
# Search for packs
ayaiay search "code review"
# Install a pack
ayaiay install publisher/pack-name
# List installed packs
ayaiay list
# Get pack information
ayaiay info publisher/pack-name
Quick Start: Using ayaiay MCP
Prerequisites
- .NET 8.0 or higher
- An MCP-compatible client (Claude Desktop, Cline, etc.)
Installation
# Clone the repository
git clone https://github.com/ayaiayorg/ayaiay-mcp.git
cd ayaiay-mcp
# Build the project
dotnet build
# Run the MCP server
dotnet run
Configuration
Add to your MCP client configuration (e.g., Claude Desktop):
{
"mcpServers": {
"ayaiay": {
"command": "dotnet",
"args": ["run", "--project", "/path/to/ayaiay-mcp"],
"env": {
"AYAIAY_API_URL": "https://ayaiay.org"
}
}
}
}
What Can You Do with Packs?
Once you've found or installed a pack, you can use its resources:
Agents
Agent profiles define AI personalities and capabilities. Use them to:
- Configure AI assistants with specific expertise
- Define behavioral guidelines and constraints
- Set model preferences and parameters
Instructions
Detailed guidelines for AI behavior. Use them to:
- Provide task-specific instructions
- Define workflows and processes
- Establish quality standards
Prompts
Reusable prompt templates. Use them to:
- Standardize common tasks
- Create parameterized prompts with variables
- Build prompt libraries for your team
MCP Servers
Model Context Protocol servers. Use them to:
- Extend AI capabilities with custom tools
- Provide structured data and resources
- Integrate with external systems
Next Steps
- Explore the catalog: Browse available packs
- Install the CLI: CLI Installation Guide
- Create your first pack: Pack Creation Guide
- Learn about MCP: MCP Server Guide
Need Help?
- Documentation: Explore the sidebar for detailed guides
- GitHub: Report issues or request features
- Community: Connect with other ayaiay users