@yoamigo.com/cli

CLI for creating and managing YoAmigo templates.

Installation

npm install -g @yoamigo.com/cli

Quick Start

# 1. Login with your API key (get one at yoamigo.com/dev/dashboard)
yoamigo login

# 2. Create a new template
yoamigo init my-template

# 3. Start development
cd my-template
yoamigo dev

# 4. Preview in the builder
yoamigo preview

# 5. Submit for review
yoamigo deploy 1.0.0

Commands

yoamigo login

Authenticate with your YoAmigo API key. Keys can be created at yoamigo.com/dev/dashboard.

yoamigo login
# or
yoamigo login --key ya_dev_xxxxx

yoamigo init <name>

Create a new template project from the starter template.

yoamigo init my-template

yoamigo dev

Start the Vite development server for local development.

yoamigo dev

yoamigo preview

Upload your template to YoAmigo for preview in the builder. Does not submit for review.

yoamigo preview

yoamigo deploy

Deploy your template. Use --submit to submit for review.

# Deploy without submitting
yoamigo deploy

# Deploy and submit for review
yoamigo deploy --submit

Template Structure

Templates use file-based routing with auto-discovery. Pages must follow these conventions for the builder's page selector to work:

my-template/
├── src/
│   ├── App.tsx              # Root component with ContentStoreProvider
│   ├── routes.ts            # Re-exports getAvailablePages() and AppRoutes
│   ├── lib/router/routes.tsx # Auto-discovery with import.meta.glob
│   ├── pages/               # File-based routing
│   │   ├── index.tsx        # Home page (/)
│   │   ├── about.tsx        # About page (/about)
│   │   └── contact.tsx      # Contact page (/contact)
│   └── components/
├── public/
└── package.json

Page Requirements

• File naming: Use index.tsx, about.tsx (not HomePage.tsx, AboutPage.tsx)
• Default exports: Pages must use export default function PageName()
• Auto-discovery: Pages are discovered via import.meta.glob in routes.tsx

Documentation

For full documentation, visit https://www.yoamigo.com/dev/docs.

License

Proprietary - All Rights Reserved. See LICENSE file for details.