Skip to content

docs(readme): create the project with npx and open the onboarding address - #5

Merged
Upd4ting merged 2 commits into
mainfrom
docs/readme-npx-init
Nov 4, 2026
Merged

Upd4ting merged 2 commits into
mainfrom
docs/readme-npx-init

Conversation

@Upd4ting

@Upd4ting Upd4ting commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

Why

A newcomer with nothing installed should create a project with one copy-pasteable npx @antelopejs/core command and a short template slug, not a git clone of the template repository. The first-run text must also match today's onboarding flow. The backend prints a setup address with a token, and the wizard needs that address.

What changed

  • Both run paths create the project with npx @antelopejs/core project init my-project --template dms-starter in place of git clone.
  • A new "First run" section says where to find the onboarding address: the dms log with Docker, or the pnpm dev terminal without it. It also covers DMS_SETUP_TOKEN.
  • The Docker prerequisites now list Node.js and pnpm, because project init installs the packages with pnpm.

Scope

  • README only.

Blast Radius

Docs only. The slug works only once a core release ships template slugs. Today, core 1.19.0 matches only the display name. Merge this after that release.

The Docker prerequisites no longer list pnpm, and the corepack enable step is gone. This works only with the core release that ships AntelopeJS/antelopejs#381 and the interfaces PR AntelopeJS/interfaces#14 ("install": false on this template). Merge after both.

Verification

  • npx -y @antelopejs/core project init dms-starter --template "DMS Starter" --yes created the project, installed it, and ran git init.
  • The onboarding line and address come from the same @antelopejs/dms 0.15.1 that the connect demo resolves. In that demo, docker compose up printed the line in the dms log, and the address opened the wizard.

@Upd4ting
Upd4ting merged commit 5a66433 into main Nov 4, 2026
1 check passed
@Upd4ting
Upd4ting deleted the docs/readme-npx-init branch November 4, 2026 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant