ShipMyAgent
指南

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 shipmyagent

Connect Your Repo

shipmyagent init

This will prompt you to:

  1. Authenticate with GitHub
  2. Select your repository
  3. 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 deploy

Your agent is now live!

Next Steps