@accord-cms/cli
v0.1.1
Published
CLI for scaffolding and managing Accord CMS projects
Maintainers
Readme
@accord-cms/cli
Official command-line interface for scaffolding and configuring Accord CMS applications.
Accord is a code-first, self-hosted CMS built on TanStack Start and PostgreSQL with shadcn/ui-style ownership.
Quickstart
Create a new Accord CMS project in seconds:
# Bun (recommended)
bunx @accord-cms/cli create my-accord-app
# pnpm
pnpm dlx @accord-cms/cli create my-accord-app
# npm
npx @accord-cms/cli create my-accord-appThe CLI will guide you through:
- Choosing your package manager (
bun,pnpm, ornpm). - Providing your PostgreSQL connection string (
DATABASE_URL). - Installing dependencies and shadcn/ui components.
- Setting up Accord routes, actions, blocks, and schema migrations.
Commands
create [dir]
Scaffold a fresh TanStack Start application and install Accord CMS.
npx @accord-cms/cli create [dir] [options]Options:
| Flag | Description | Default |
| -------------------------- | ---------------------------------------------------- | ----------------------------------------------------- |
| --pm <pm> | Force package manager (bun, pnpm, npm, yarn) | Auto-detected |
| --database-url <url> | PostgreSQL connection string | Prompted |
| --template <template> | Starter template URI | gh:TanStack/router/examples/react/start-tailwind-v4 |
| --registry-url <url> | Accord registry base URL | https://ui.cms.kesval.com/r |
| --core-version <version> | @accord-cms/core package version | latest |
| --skip-push | Skip running drizzle-kit push on database | false |
| -y, --yes | Accept defaults without interactive prompts | false |
| --force | Overwrite non-empty target directory | false |
init [dir]
Install Accord CMS into an existing TanStack Start project.
npx @accord-cms/cli init [dir] [options]Options:
| Flag | Description | Default |
| -------------------------- | ---------------------------------------------------- | ----------------------------- |
| --pm <pm> | Force package manager (bun, pnpm, npm, yarn) | Auto-detected |
| --database-url <url> | PostgreSQL connection string | Prompted |
| --registry-url <url> | Accord registry base URL | https://ui.cms.kesval.com/r |
| --core-version <version> | @accord-cms/core package version | latest |
| --skip-push | Skip running drizzle-kit push | false |
| -y, --yes | Accept defaults without interactive prompts | false |
Requirements
- Node.js:
v18.0.0or higher - Package Manager: Bun (recommended),
pnpm, ornpm - Database: PostgreSQL (local Docker container, Supabase, Neon, Railway, etc.)
