Getting Started

1. Install

npm install -g shipmyagent
shipmyagent --version

sma is the same binary as shipmyagent.

2. Initialize a repository

cd /path/to/your-repo
sma agent create .

Initialization generates:

• PROFILE.md (required)
• SOUL.md / USER.md (optional)
• ship.json
• .ship/ runtime directory

3. Configure LLM

Create .env at project root (do not commit):

LLM_API_KEY=your_key

Minimal ship.json example:

{
  "name": "my-agent",
  "version": "1.0.0",
  "model": {
    "primary": "default"
  }
}

4. Start runtime

Start runtime (default: background daemon):

sma agent on

Use foreground mode when you want logs in the current terminal:

sma agent on --foreground

5. Verify health

curl http://localhost:3000/health
curl http://localhost:3000/api/status

6. Optional: add alias to shell rc

sma console config alias

Next

• Configuration
• Skill Service
• Task Service
• Troubleshooting