@doswiftly/cli

Official CLI for building e-commerce storefronts powered by DoSwiftly Commerce API.

Who is this for?

This CLI is designed for storefront developers — developers building custom Next.js e-commerce applications using the DoSwiftly Commerce platform. If you're a merchant or business owner, you'll work with a developer who uses this tool.

Installation

npm install -g @doswiftly/cli

Quick Start

doswiftly init my-shop    # Create a new storefront project
cd my-shop
doswiftly auth login       # Login to DoSwiftly
doswiftly dev              # Start development server

Your storefront will be running at http://localhost:3000.

Commands Overview

| Command | Description | | --- | --- | | doswiftly init [name] | Create a new storefront project | | doswiftly dev | Start development server | | doswiftly auth login | Login to DoSwiftly (OAuth) | | doswiftly deploy run | Deploy storefront to production | | doswiftly preview create | Create a preview environment | | doswiftly env add | Add environment profile (dev/staging/prod) | | doswiftly doctor | Check project health | | doswiftly whoami | Show current user and project info |

Run doswiftly --help for the full list of commands.

Documentation

Full documentation, including detailed command reference, environment management, deployment pipeline, and SDK integration:

• CLI Overview — installation, configuration, environments, deployment
• CLI Commands Reference — all commands with options and examples
• SDK Overview — Commerce SDK hooks, stores, and architecture

Requirements

• Node.js >= 18
• Package manager: pnpm (recommended), npm, yarn, or bun
• DoSwiftly Commerce account

License

MIT