指南
Getting Started
Get started with ShipMyAgent
Get up and running with ShipMyAgent in minutes.
What You'll Get
- Turn your repository into a conversational, schedulable, and auditable Agent Runtime.
Prerequisites
- Node.js 18+
- GitHub account
- OpenAI API key (or compatible)
Installation
npm install -g shipmyagentConnect Your Repo
shipmyagent initThis will prompt you to:
- Authenticate with GitHub
- Select your repository
- Configure your agent
Configure Your Agent
Edit the shipmyagent.config.ts file in your repo root:
export default {
name: "My Agent",
instructions: "You help users understand this codebase",
tools: ["read_file", "search_code"],
};Deploy
shipmyagent deployYour agent is now live!
Next Steps
- Configuration Guide - Advanced configuration options