Installation
Run the CLI with npx or install it globally, check the Node version Askr needs, and confirm a scaffolded project starts.
Example
Create a starter, start the development server, and verify the production build.
npx @askrjs/cli@latest create startkit my-app
cd my-app
npm run dev
npm run buildRuntime requirements
You need Node.js 24 or later and npm to install and run current Askr projects; the CLI's dist/cli.js is a Node binary invoked as askr. Generated projects are ES modules ("type": "module") and expect a modern bundler-driven dev workflow, which the CLI templates already wire up for you.
Create with the CLI
Run it without installing anything — npx @askrjs/cli@latest create <template> <name> — or install @askrjs/cli globally (npm install -g @askrjs/cli) to get the askr command on your PATH. Template is one of spa, ssr, ssg, full-stack, or startkit. This scaffolds the project, installs bundled agent skills into skills/ unless you pass --no-skills, and runs the install for you unless you pass --no-install.
Install packages directly
If you're adding Askr to an existing project instead of scaffolding a new one, install @askrjs/askr directly with npm install @askrjs/askr and import from its subpaths as needed — @askrjs/askr for state and JSX, @askrjs/askr/boot for startup, @askrjs/askr/router for routing. The CLI itself is consumed mostly as the askr binary, not imported into application code — the one exception is @askrjs/cli/ssg, a types-only subpath for typing an ssg.config.ts module.
Verify the install
Run npm run dev from a scaffolded project and confirm the dev server starts and the starter route renders in the browser. For a manual install, a quick sanity check is importing state from @askrjs/askr and calling it inside a component — if the getter and setter behave as expected, the runtime is wired correctly.