create-justscale
v0.1.1
Published
Create a new JustScale project
Downloads
249
Readme
create-justscale
Project scaffolder for pnpm create justscale / npm create justscale@latest / yarn create justscale. Interactive prompt, detects your environment (OS, package manager, installed IDEs, AI tools, git hosting), then writes a minimal JustScale app with matching IDE + CI config.
Not a package you import — it's a CLI. Run it to bootstrap a new project.
Usage
pnpm create justscale
# or
npm create justscale@latest
# or
yarn create justscaleYou can also invoke it directly:
pnpm dlx create-justscaleThe CLI asks for a project name (default: current directory name). If the name matches the current directory, it scaffolds in place; otherwise it creates a subdirectory. It refuses to run in a directory that already has a package.json — use just init for that case.
What gets generated
Always:
package.jsonwith@justscale/coreand@justscale/typescriptpinnedtsconfig.json(NodeNext, ES2022, strict)justscale.config.tswithdefineProjectandserve/climode entriessrc/app.ts,src/serve.ts,src/cli.tsstubs.gitignore
Based on detected environment:
- JetBrains IDE (WebStorm / IntelliJ):
.idea/typescript.xmlpointing at@justscale/typescript's tsserver, plusjust dev/just build/just testrun configurations. - VS Code / Cursor:
.vscode/settings.jsonwithtypescript.tsdkpointed at the workspace JustScale TypeScript, plus alaunch.jsonforjust dev. - Claude CLI on PATH:
.claude/settings.jsonwiring the JustScale MCP server (just mcp serve) and a starterCLAUDE.md. - GitHub remote:
.github/workflows/ci.ymlmatching the detected package manager. - GitLab remote:
.gitlab-ci.ymlequivalent.
After scaffolding, the CLI runs <pm> install, initialises git, and optionally opens your detected editor / Claude session.
Detection
Detection is best-effort and purely read-only:
- OS / arch from
process.platform - Package manager via
which pnpm/yarn(falls back tonpm) - IDEs by scanning app locations on macOS/Linux plus
code/cursoron PATH - AI tools by
claude/cursoron PATH - Git hosting from
.git/config(github.com, gitlab.com)
No network calls, no telemetry.
Starter app shape
The generated app.ts is intentionally empty — a JustScale() builder with comments showing where to .add(...) services / features:
import JustScale from '@justscale/core'
export const app = JustScale()
// Add services, features, and adapters here
// .add(PostgresClient)
// .add(AuthFeature)serve.ts and cli.ts each .build() it for their respective modes; justscale.config.ts wires the modes together. From there you follow the docs to add controllers, features, and an adapter.
Next steps
cd your-project-name
just dev # boots the app
just install <plugin> # installs and wires a JustScale pluginDocs
https://justscale.sh/docs/overview/quick-start
