Skip to Content
Getting StartedFirst Steps

First Steps

Once you have the ShipMore repo and environment set up, follow the steps below.

Quick path: pnpm install → copy .env.example to .env and set required vars → pnpm dev → open /admin and create the first admin user → create a tenant → install the CLI.

Install and run

In the project root:

pnpm install
pnpm dev

The dev server starts on port 3000.

URLs

  • Admin — http://localhost:3000/admin. Manage tenants, pages, products, records, schemas.
  • Docs — http://localhost:3000/docs. This documentation, served from content/.
  • Frontend (tenant site) — Depends on the tenant’s domain. After you configure a tenant with domain localhost:3000, open http://localhost:3000.

First admin user

If the database is empty, the first time you open /admin you’ll be prompted to create an admin user. Use a secure password — this user can manage all Payload collections.

Create your first tenant

Admin → Tenants → Create New. Set:

  • Name — internal label (e.g. “My Site”)
  • Domain — localhost:3000 for local dev

Save, then visit http://localhost:3000 to see the tenant’s frontend. See Configure Tenants for the full options (theme, branding, legal, multi-tenant local setup).

Install the CLI

The shipmore CLI is the canonical operator surface — it’s how humans and agents drive the box for ingest, page composition, products, and monitoring.

  1. In the admin: Users → your operator user → enable API Key → Generate → copy.
  2. Install + auth:
curl -fsSL http://localhost:3000/cli/install.sh | bash
export SHIPMORE_API_URL=http://localhost:3000
export SHIPMORE_API_KEY=<your-key>
shipmore --version
  1. Smoke test against your tenant:
shipmore tenant list

See Agents & CLI → CLI for the full command surface.

First import (optional)

If you have a CSV or JSON file of records to bring in:

shipmore schema infer --tenant localhost:3000 --data-file ./sample.csv > /tmp/schema.json
# review/edit /tmp/schema.json
shipmore schema apply --tenant localhost:3000 --fields-file /tmp/schema.json
shipmore import       --tenant localhost:3000

Then visit http://localhost:3000/explore to see the records browse surface. See Data → Import for the full flow.

What’s next

Environment SetupConfigure Tenants