11# create-shape-app
22
3- CLI for scaffolding Shape apps from the Builder Kit template pinned to release tags.
3+ [ ![ npm version] ( https://img.shields.io/npm/v/create-shape-app )] ( https://www.npmjs.com/package/create-shape-app )
4+ [ ![ license] ( https://img.shields.io/npm/l/create-shape-app )] ( ./LICENSE )
5+
6+ CLI for scaffolding [ Shape] ( https://shape.network ) apps from the [ Builder Kit] ( https://github.com/shape-network/builder-kit ) template.
47
58## Quick Start
69
7- Choose one:
8- - ` npx create-shape-app `
9- - ` bunx create-shape-app `
10+ ``` bash
11+ npx create-shape-app my-app
12+ ```
13+
14+ Other package managers:
15+
16+ - ` bunx create-shape-app my-app `
17+ - ` pnpm dlx create-shape-app my-app `
18+ - ` yarn create shape-app my-app `
19+
20+ ## What You Get
21+
22+ A monorepo with everything needed to build on Shape:
23+
24+ - ** ` apps/web ` ** -- Next.js frontend with wagmi, viem, and wallet connection
25+ - ** ` packages/contract ` ** -- Hardhat project with a sample contract, deploy scripts, and tests
26+ - Pre-configured for Shape mainnet and Shape Sepolia
27+ - TypeScript throughout, Tailwind CSS styling
28+
29+ ## CLI Options
30+
31+ | Flag | Description |
32+ | ------| -------------|
33+ | ` -y, --yes ` | Skip confirmation prompts |
34+ | ` --pm <bun\|npm\|pnpm\|yarn> ` | Select package manager |
35+ | ` --skip-install ` | Skip dependency install step |
36+ | ` --skip-git ` | Skip git init + initial commit |
37+ | ` --template-ref <tag> ` | Pin to a specific Builder Kit release tag |
38+ | ` -h, --help ` | Show help |
39+ | ` -v, --version ` | Show version |
40+
41+ If ` project-name ` is omitted in an interactive terminal, you will be prompted.
42+ If ` --pm ` is omitted in an interactive terminal, you can pick a package manager.
1043
1144## Behavior
45+
1246- Scaffolds from ` shape-network/builder-kit ` release tags only (` latest ` by default).
1347- Rejects non-release refs (for example ` main ` ) and canary tags.
1448- In non-interactive terminals, ` --yes ` is required.
15- - In interactive terminals, package manager is selectable when ` --pm ` is not provided.
1649- Copies template files, excluding VCS/internal maintainer metadata.
1750- Applies defaults:
1851 - Root ` package.json ` name is set from the project directory name.
@@ -21,6 +54,7 @@ Choose one:
2154 - Git is initialized unless ` --skip-git ` is set.
2255
2356## Troubleshooting
57+
2458- GitHub API rate limit during template lookup:
2559 - retry later, set ` GITHUB_TOKEN ` , or pass ` --template-ref <tag> ` .
2660- Git init or commit failure:
@@ -38,12 +72,21 @@ bun run test
3872```
3973
4074## Publish
75+
4176- Trigger: GitHub release publish event.
4277- Guard: workflow checks release tag matches ` package.json ` version.
4378- Requirement: repository secret ` NPM_TOKEN ` must be configured.
4479- Publish target: npm package ` create-shape-app ` .
4580
81+ ## Links
82+
83+ - [ Shape] ( https://shape.network )
84+ - [ Shape docs] ( https://docs.shape.network )
85+ - [ Shape Discord] ( http://discord.com/invite/shape-l2 )
86+ - [ Builder Kit] ( https://github.com/shape-network/builder-kit )
87+
4688## Community
89+
4790- Contribution guide: ` CONTRIBUTING.md `
4891- Security policy: ` SECURITY.md `
4992- Code of conduct: ` CODE_OF_CONDUCT.md `
0 commit comments