bkinnightskytw
/
agent-orchestrator
mirror of https://github.com/ComposioHQ/agent-orchestrator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
agent-orchestrator/examples
History
Prateek 4ddaef3ae8 feat: implement seamless onboarding with enhanced documentation 
- Add comprehensive README.md (18KB) with quick start, core concepts, and FAQ
- Add detailed SETUP.md (16.5KB) with prerequisites, integration guides, and troubleshooting
- Add examples/ directory with 5 ready-to-use config templates:
  - simple-github.yaml: Minimal GitHub setup
  - linear-team.yaml: Linear integration
  - multi-project.yaml: Multiple repos
  - auto-merge.yaml: Aggressive automation
  - codex-integration.yaml: Using Codex agent

- Add environment detection (git repo, remote, branch, auth status)
- Auto-fill prompts with smart defaults from detected environment
- Add prerequisite validation (git, tmux, gh CLI)
- Show actionable next steps and warnings
- Parse owner/repo from git remote automatically
- Detect LINEAR_API_KEY and SLACK_WEBHOOK_URL in environment
- Prompt for Linear team ID when Linear tracker selected

- Format all files with Prettier for consistency

Reduces onboarding time from 30+ minutes to ~5 minutes:
1. Install CLI: `npm install -g @composio/ao-cli`
2. Run init: `ao init` (auto-detects everything)
3. Spawn agent: `ao spawn my-project ISSUE-123`

Users no longer need to:
- Manually parse git remote URLs
- Look up current branch names
- Remember YAML syntax
- Search for Linear team IDs
- Debug missing prerequisites

- ✅ pnpm build - All packages compile
- ✅ pnpm typecheck - No TypeScript errors
- ✅ pnpm lint - No new linting issues
- ✅ pnpm format - All files formatted

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 		2026-02-16 20:29:41 +05:30
..
README.md feat: implement seamless onboarding with enhanced documentation 2026-02-16 20:29:41 +05:30
auto-merge.yaml feat: implement seamless onboarding with enhanced documentation 2026-02-16 20:29:41 +05:30
codex-integration.yaml feat: implement seamless onboarding with enhanced documentation 2026-02-16 20:29:41 +05:30
linear-team.yaml feat: implement seamless onboarding with enhanced documentation 2026-02-16 20:29:41 +05:30
multi-project.yaml feat: implement seamless onboarding with enhanced documentation 2026-02-16 20:29:41 +05:30
simple-github.yaml feat: implement seamless onboarding with enhanced documentation 2026-02-16 20:29:41 +05:30

README.md

Agent Orchestrator Config Examples

This directory contains example configurations for common use cases.

Quick Start

Copy an example and customize:

cp examples/simple-github.yaml agent-orchestrator.yaml
nano agent-orchestrator.yaml  # edit as needed
ao spawn my-app ISSUE-123

Examples

simple-github.yaml

Minimal setup with GitHub Issues

Perfect for getting started. Just specify your repo and you're ready to spawn agents.

Use this if:

  • You're working on a single GitHub repository
  • You want to use GitHub Issues for task tracking
  • You want the simplest possible setup

linear-team.yaml

Linear integration

Integrates with Linear for issue tracking. Requires LINEAR_API_KEY environment variable.

Use this if:

  • Your team uses Linear for project management
  • You want agents to update Linear ticket status
  • You need custom agent rules per project

multi-project.yaml

Multiple repos with different trackers

Shows how to manage multiple projects with different trackers and notification routing.

Use this if:

  • You're managing multiple repositories
  • Different projects use different trackers (GitHub Issues vs Linear)
  • You want Slack notifications in addition to desktop
  • You need different rules per project

auto-merge.yaml

Aggressive automation with auto-merge

Automatically merges approved PRs with passing CI. Auto-retries CI failures and review comments.

Use this if:

  • You trust your agents and CI pipeline
  • You want maximum automation
  • You want agents to handle routine failures autonomously
  • You want escalation only when agents get stuck

codex-integration.yaml

Using Codex instead of Claude Code

Shows how to use a different AI agent (Codex) instead of the default Claude Code.

Use this if:

  • You prefer GPT-4/Codex over Claude
  • You need agent-specific configuration
  • You're evaluating different AI coding assistants

Configuration Tips

  1. Start simple - Use simple-github.yaml as a starting point
  2. Add complexity incrementally - Enable features as you need them
  3. Test with one project first - Get comfortable before adding multiple projects
  4. Review defaults - Most sensible defaults are already configured
  5. Use environment variables - Store API keys in env vars, not config files

Environment Variables

These environment variables are commonly used:

# Linear integration
export LINEAR_API_KEY="lin_api_..."

# Slack notifications
export SLACK_WEBHOOK_URL="https://hooks.slack.com/services/..."

# GitHub (usually set by gh CLI)
# export GITHUB_TOKEN="ghp_..."

Add these to your shell profile (~/.zshrc or ~/.bashrc) to persist them.

Next Steps

After copying an example:

  1. Edit the config - Update repo paths, team IDs, etc.
  2. Validate - Run ao start to check for config errors
  3. Spawn an agent - Try ao spawn project-id ISSUE-123
  4. Monitor - Use ao status or open the dashboard at http://localhost:3000

See SETUP.md for detailed configuration reference and troubleshooting.