Installation

1. Create a Project Directory

mkdir my-shevky-site
cd my-shevky-site
npm init -y

2. Install Core and Plugins

Install the core CLI and commonly used plugins:

npm install @shevky/core \
  @shevky/plugin-robots-txt \
  @shevky/plugin-tailwindcss \
  @shevky/plugin-esbuild \
  @shevky/plugin-rss \
  @shevky/plugin-sitemap

Optional plugins for advanced use cases:

npm install @shevky/plugin-content-bridge @shevky/plugin-open-graph

3. Bootstrap Starter Files

npx shevky --init

This command (implemented in core/scripts/init.js):

  • Clones the starter template fatihtatoglu/shevky-simple-blog via degit.
  • Copies src/ directory and tailwind.config.js to your project.
  • Installs additional build dependencies (Tailwind, esbuild, marked, etc.).
  • Creates a .gitignore file.
  • Adds build and dev scripts to your package.json.

4. Verify CLI Access

npx shevky --help

You should see the help output listing available flags: --help, --version, --init, --build, --dev.

Common Setup Errors

ErrorFix
shevky: command not foundUse npx shevky ... instead of shevky ...
package.json not found during initRun npm init -y first in the project directory
Tailwind/esbuild missing at build timeRe-run npm install and verify node_modules exists

Related