create-openclawd

create-openclawd

One-command scaffolder for OpenClawd OS. Drops the whole agentic OS into a new folder, installs deps, and points you at the setup wizard.

npm create openclawd@latest my-aios

That creates my-aios/, copies the OS in, runs npm install, then drops you straight into the interactive setup wizard. When the wizard finishes, the only thing left is npm run dev.

Options

npm create openclawd@latest my-aios -- --no-setup     # stop after install
npm create openclawd@latest my-aios -- --no-install   # files only (implies --no-setup)
npm create openclawd@latest .       -- --force        # scaffold into a non-empty folder
npm create openclawd@latest -- --help

Note the -- before flags: it tells npm to pass them through to the scaffolder instead of eating them.

How it works

• The published package bundles template/, a clean copy of the OpenClawd OS repo (source, agents, skills, warroom, scripts, configs). No node_modules, dist, store, or secrets are included.
• index.mjs copies template/ into your target dir and renames the shipped gitignore back to .gitignore (npm strips files literally named .gitignore from tarballs).
• After install it launches npm run setup for you (the interactive wizard). The wizard still prompts for keys + bot token, so nothing secret is automated, you just skip the manual cd + retype. Pass --no-setup to stop after install.

The repo root stays the single source of truth. template/ is generated, never hand-edited, and is gitignored.

Testing it locally (before publishing)

cd packages/create-openclawd
node prepare-template.mjs                 # build ./template from the repo root
node index.mjs ../../_scaffold-test --no-install
# inspect _scaffold-test/, then delete it

Publishing

template/ is rebuilt automatically on npm pack/npm publish via the prepack script, so you do not commit it.

cd packages/create-openclawd
npm publish --access public      # bump version first if needed

After it is live, npm create openclawd@latest <dir> works from any machine with Node 20+.

The bare name openclawd is already taken on npm, but the scaffolder name create-openclawd is free, which is all npm create openclawd needs. Keep this package's version in step with the root app version so users can tell which OS build they are scaffolding.