Skip to Content
Getting StartedOverview

Getting Started

After purchase you’ll get access to the ShipMore repository. Use the steps below to go from download to a running app with your first tenant and CLI.

Steps

  1. Download & access — clone the repo with the access token from your purchase. See Download & Access.
  2. Install — pnpm install in the project root.
  3. Environment — copy .env.example to .env and set the required variables. See Environment Setup.
  4. Run — pnpm dev and open the URLs listed in First Steps.
  5. First admin user + tenant — create your operator user at /admin, then add a tenant. See Configure Tenants.
  6. CLI — generate an API key for your user, install the shipmore CLI, and smoke-test it. See First Steps → Install the CLI and Agents & CLI → CLI.
  7. First import (optional, when you have data) — shipmore schema infer → schema apply → import. See Data → Import.

Once you’ve completed 1–6, you have the app running, one tenant you can visit by domain, and a CLI authenticated against it.

IntroductionDownload & access