scaffolder-toolkit

🚀 Scaffolder-Toolkit (dk)

A universal CLI for professional developers to automate project scaffolding and streamline workflows.

Scaffolder-Toolkit (dk) is a powerful command-line tool designed to boost your productivity by automating repetitive tasks. Whether you're setting up a new machine or starting a new project, dk is your essential solution for project automation.

Built to fit the modern developer workflow, dk seamlessly integrates into monorepos and supports a wide range of features to help you start coding faster.

✨ Key Features

• Unified Command: Access all features with the short, intuitive command dk.
• Intelligent Scaffolding: Create new projects from a wide variety of popular frameworks with a single, intuitive command. You can also use custom templates for a consistent workflow. See the list of supported templates below.
• Node.js Ecosystem Support: All commands and templates are currently designed for and support the Node.js ecosystem, including projects managed with npm, Yarn, pnpm, and Bun. This includes JavaScript, TypeScript, and any project that relies on a Node.js runtime or a similar engine like Bun for dependency management and execution. You can use either the full language name or its alias (e.g., javascript or js, typescript or ts, nodejs or node) when executing commands.
• Robust Configuration: The tool reliably finds your configuration file (.devkit.json) in any project or monorepo structure. It uses a clear priority system to manage both local and global settings.
• Powerful Cache Management: Optimize project setup speed with flexible caching strategies for your templates. These strategies are mainly applied when using a GitHub URL:
  • always-refresh: Always pull the latest template from the remote repository.
  • never-refresh: Use the local cached template without checking for updates.
  • daily (default): Refresh the cache only once every 24 hours.
• Seamless Internationalization (i18n): The CLI supports multiple languages, with all commands and descriptions dynamically translated. It will automatically use the language defined in your configuration files or detect your system's language as a fallback for a seamless out-of-the-box experience.
• Centralized Settings: Manage your preferred package manager (npm, yarn, pnpm, bun) and cache strategy with a single command.

📂 Use Cases

The Scaffolder CLI streamlines development workflows in various environments:

• Globally Installed CLI: Install scaffolder-toolkit globally for a universal scaffolding tool on your machine.
• Monorepo: A single configuration file at the root can manage settings and templates for all projects, ensuring consistency across your entire codebase.
• Multiple Repositories: Each project can have its own .devkit.json file for unique settings, allowing for flexible project management.

🗺️ Supported Languages

The CLI's internationalization (i18n) feature dynamically translates commands and descriptions. Currently, the following languages are supported:

• English (en)
• French (fr)

🚀 Getting Started

Prerequisites

Ensure you have Node.js (v20.19.0 or higher) and a package manager installed.

Installation

Install Scaffolder globally using your preferred package manager.

# using bun
bun install -g scaffolder-toolkit

# using npm
npm install -g scaffolder-toolkit

# using pnpm
pnpm install -g scaffolder-toolkit

# using yarn
yarn global add scaffolder-toolkit

Usage

Since this is a Node.js-based CLI, you can run it using your package manager's runner.

# using bun
bunx dk --help

# using npm
npx dk --help

# using pnpm
pnpx dk --help

# using yarn
yarn dk --help

Advice: To use the command directly as dk, consider creating an alias in your shell configuration file (e.g., .bashrc, .zshrc, or config.fish).

# Example for Bash or Zsh
echo 'alias dk="bunx dk"' >> ~/.zshrc
source ~/.zshrc

Global Options

In addition to the options for each command, you can use global flags that affect the entire CLI's output.

• -v, --verbose: Provides more detailed output during execution. It's particularly useful for debugging or when you want to see exactly what the CLI is doing behind the scenes.
• -V, --version: Output the version number.

📦 Default Templates

Scaffolder comes with a set of pre-configured templates for popular frameworks and libraries. You can use these templates out of the box with the dk new command.

Note: All templates currently support Node.js projects and must be configured under the canonical language key (javascript, typescript, or nodejs) in your config file. However, you can use the short aliases (js, ts, node) when running any dk command.

Template Name	Description	Alias
vue	An official Vue.js project.
nuxt	An official Nuxt.js project.	nx
nest	An official Nest.js project.
nextjs	An official Next.js project.	next
express	A simple Express.js boilerplate.	ex
fastify	A highly performant Fastify web framework boilerplate.	fy
koa	A Koa.js web framework boilerplate.
adonis	A full-stack Node.js framework (AdonisJS).	ad
sails	A real-time, MVC framework (Sails.js).
angular	An official Angular project (via Angular CLI).	ng
angular-vite	An Angular project using Vite (via AnalogJS).	ng-v
react	A React project using the recommended Vite setup.	rt
svelte	A Svelte project using SvelteKit.
qwik	An official Qwik project.
astro	A new Astro project.
solid	An official SolidJS project.
remix	An official Remix project.

⚙️ Usage

Here's how to get started with the Scaffolder CLI.

View System and Configuration Info

The dk info command displays detailed information about your system environment and the Scaffolder CLI's current configuration status. This is extremely useful for debugging and understanding why configuration files are or are not being loaded.

# Display CLI version, runtime, OS, package manager, and config file status
dk info

Create a new project from a template

The new command now takes a language and a project name as arguments. You can then specify the template with the -t or --template flag.

# Create a new Vue project using the 'js' language alias
dk new js my-awesome-app -t vue

# Create a new Vue project using the full 'javascript' name
dk new javascript my-awesome-app -t vue

List available templates

The dk list command allows you to view all available templates defined in your configuration. You can filter the list using optional flags to specify the configuration scope.

# List all templates, prioritizing the local config
dk list

# List templates for a specific language (e.g., 'javascript' or its alias 'js')
dk list js

# List templates and filter by a where clause (e.g., 'name:vue')
dk list --where name:vue

Options

The dk list command now uses the following options to control which templates are displayed:

• -d, --include-defaults: Include Scaffolder's built-in, default templates in the list. By default, only templates defined in your local or global config files are shown.
• --local: Only list templates from the local configuration file (.devkit.json).
• --global: Only list templates from the global configuration file (~/.devkitrc).
• --all: List templates from both the local and global configurations, merging them into a single list.
• --where <clause>: Filter templates using one or more property clauses. Clauses must be in the format property:value or property=value (e.g., alias:rt, pm=npm, name:/^node/). Multiple --where arguments form a logical AND filter.
• --mode <mode>: Sets the display mode for the template list. Options are tree (default, detailed view) or table (compact, column-based view).

Examples

Here are some examples of how to use the new options:

# List all templates, including the Scaffolder's built-in defaults
dk list -d

# List templates only from the local configuration file
dk list --local

# List templates only from the global configuration file
dk list --global

# List templates from both local and global configs
dk list --all

# List templates and filter by alias 'rt' (using colon) AND package manager 'npm' (using equals)
dk list --where alias:rt --where pm=npm

# List javascript templates and filter by templates whose name starts with 'r'
dk list js --where name:/^r/

# List templates in a compact table format, including defaults
dk list --mode table -d

Manage your CLI configuration (dk config / dk conf)

The dk config command is the central hub for managing your CLI settings and templates.

Get and Set Configuration Values (Core)

The main dk config command allows you to get or set simple configuration values like your preferred package manager or language.

Action	Command Syntax	Description
GET (Read)	dk config <key...>	Retrieve the value(s) for the specified configuration key(s). Supported keys include: pm / defaultPackageManager, lang / language, and cache / cacheStrategy.
SET (Write)	dk config --set <key value...>	Set one or more configuration properties in bulk (key-value pairs).

# Get the value of the 'defaultPackageManager' setting using its short alias
dk config pm

# Get the value of both 'language' and 'cacheStrategy' from the global config
dk config language cacheStrategy --global

# Set your default package manager to pnpm and the language to French in a single command (local)
dk config --set pm pnpm lang fr

# Set your default package manager to npm in your global config
dk config --set defaultPackageManager npm --global

List detailed configuration and templates

The dk config list command provides a detailed, comprehensive view of your configuration. Unlike the top-level dk list command, this subcommand shows both the settings and templates from the active configuration files. It's useful for debugging and getting a full overview of your current setup.

• The -d, --include-defaults option includes Scaffolder's default settings and templates in the output.
• The --global option forces the command to only display settings and templates from your global configuration file (~/.devkitrc), ignoring any local configuration.
• The --all option displays a merged view of your local and global configurations, showing the final effective settings.

# List the full configuration (settings and templates) from the local project, with global as fallback
dk config list

# List configuration only from the global file
dk config list --global

# List a merged view of the local and global configurations, including defaults
dk config list --all -d

Add a new template

The dk config add command allows you to easily register a new template with your CLI. It intelligently updates the configuration file in your current context.

# Add a new template from a GitHub repository using the 'js' language alias
dk config add js react-ts-template --description "My custom React TS template" --location https://github.com/my-user/my-react-ts-template.git

Update a template's configuration

The dk config update command allows you to modify an existing template's properties.

• You must provide the language and the name of the template(s) you wish to update.
• Wildcard Support: Use the wildcard character * in place of a template name (e.g., dk config update js *) to apply the update to all templates registered under that language.
• Multiple Templates: You can list multiple template names to apply the exact same property updates to all of them.
• You can also update the template's name using the --new-name flag (this flag only works when updating a single template).
• Use the --global flag to update templates in your global (~/.devkitrc) file.

# Update the description and alias for a single template using the canonical language name
dk config update javascript my-template --description "A new and improved description" --alias "my-alias"

# Apply a new package manager to ALL javascript templates in the local config using the 'js' alias
dk config update js * --package-manager bun

# Change a template's name and its description in a single command
dk config update js my-template --new-name my-cool-template --description "A newly renamed template"

Remove an existing template from your configuration

The dk config remove command allows you to delete one or more templates from your configuration file.

• You must provide the language and the name(s) of the template(s) you wish to remove.
• Wildcard Support: Use the wildcard character * in place of a template name (e.g., dk config remove js *) to remove all templates registered under that language.
• Multiple Templates: You can list multiple template names to remove them all in one operation (e.g., dk config remove js template1 template2).
• Global: You can explicitly remove the template from your global (~/.devkitrc) file using the --global flag.
• Local: It removes the template from the .devkit.json file in the root of your current project.

# Remove the 'react-ts-template' for 'javascript' from the local config using the 'js' alias
dk config remove js react-ts-template

# Remove ALL javascript templates from the local config using the 'js' alias
dk config remove js *

# Remove multiple templates at once from the local config
dk config remove js template1 template2

# Remove the 'node-api' template from the global config
dk config remove node node-api --global

Shortcuts

For a faster workflow, the following commands have shortcuts:

Command	Alias
devkit	dk
info	in
init	i
config	conf
new	n
list	ls
config add	conf a
config remove	conf rm
config update	conf up
config list	conf ls
version	v
help	h

⚙️ Configuration

Manage your configuration either through the CLI or by manual editing.

Configuration Hierarchy

Scaffolder now loads settings with a clear priority to give you maximum control and flexibility.

• Local Project Configuration (./.devkit.json): This file, at the root of your project, takes the highest priority.
• Global Configuration (~/.devkitrc): This file, stored in your user's home directory, is used for all projects on your machine and is overridden by a local configuration.
• System Language Detection: If a language setting is not found in either the local or global configuration, dk will automatically detect your system's language and load the corresponding translations.
• Default: If none of the above are found, the language will default to English (en).

Template Configuration

Scaffolder provides a set of default templates and we'll progressively add more.

Template location and the {pm} Placeholder

The location property for a custom template can be an absolute path, a relative path, a GitHub URL, or a command.

For command-based templates (like those using create-react-app or create-nuxt-app), you can use the special placeholder {pm} within the location string.

Placeholder	Description
{pm}	This token is dynamically replaced at runtime with the effective package manager (e.g., npm, pnpm, bun, or yarn) defined in your CLI's settings.

This ensures that the template command always uses your preferred package manager without needing to hardcode it.

Note: Cache strategies are only applied when using a GitHub URL.

You can also define an alias to make it easier to reference a specific template. An alias is a simple shortcut for a template's name.

{
  "templates": {
    "javascript": {
      "templates": {
        "my-local-template": {
          "description": "A template from my local machine",
          "location": "/Users/myuser/projects/my-local-template"
        },
        "from-github": {
          "description": "A template from a GitHub repository",
          "location": "https://github.com/my-user/my-template-repo.git",
          "alias": "gh-template",
          "cacheStrategy": "daily"
        },
        "from-create-command": {
          "description": "Uses the native `create` command with the configured package manager",
          "location": "{pm} create nuxt@latest",
          "packageManager": "bun"
        }
      }
    }
  }
}

Using a custom template with an alias

Once an alias is configured, you can use it in place of the full template name for faster commands.

# Create a new project from the alias 'gh-template'
dk new js my-new-project-name -t gh-template

Create and configure a project file

The init command allows you to initialize a configuration file at different scopes.

Note: If a configuration file already exists at the specified location, you will be prompted to confirm if you want to overwrite it. To skip the confirmation prompt and force overwrite, use the --yes flag.

• To initialize a local configuration file in your current project, use the --local flag, or run the command without any flags. The file will be named .devkit.json.
• To initialize a global configuration file, use the --global flag. The file will be named .devkitrc.

# Initialize a local configuration file in the current directory (default)
dk init

# Initialize a local configuration file and automatically overwrite if it exists
dk init --local --yes

# Initialize a global configuration file and force overwrite using the short alias
dk init --global -y

Add the JSON Schema for Autocompletion

To get autocompletion and validation for your .devkit.json or .devkitrc file, you have a couple of options.

Option 1: Direct Link in the JSON File

This is the recommended approach for most developers. Simply add the $schema property as the very first key in your .devkit.json or .devkitrc file. Modern editors like VS Code will automatically read this property and apply the schema without any additional configuration.

{
  "$schema": "https://gist.githubusercontent.com/IT-WIBRC/baab4cc74a28af5b23936f5cf576f8e6/raw/ac5d88b59dd12c0714cacff88711e52e6d5f0e90/devkit-schema.json",
  "settings": {
    "language": "fr",
    "defaultPackageManager": "npm",
    "cacheStrategy": "daily"
  },
  "templates": {
    "javascript": {
      "templates": {
        "react": {
          "description": "A robust React project with TypeScript",
          "location": "https://github.com/IT-WIBRC/react-ts-template.git",
          "alias": "rt"
        },
        "nextjs": {
          "description": "A Next.js project with ESLint and TypeScript",
          "location": "{pm} create next-app@latest",
          "packageManager": "npm"
        }
      }
    }
  }
}

Option 2: IDE-specific Configuration

If you do not want to add the $schema property directly to your file, you can configure your IDE's settings to link the file name to the schema URL. This is useful for monorepos or when you need a global setting.

For VS Code, open your settings.json file and add the following entry:

{
  "json.schemas": [
    {
      "fileMatch": [".devkit.json", ".devkitrc"],
      "url": "https://gist.githubusercontent.com/IT-WIBRC/baab4cc74a28af5b23936f5cf576f8e6/raw/ac5d88b59dd12c0714cacff88711e52e6d5f0e90/devkit-schema.json"
    }
  ]
}

Or using the one from node_modules(recommended if you have it installed):

{
  "json.schemas": [
    {
      "fileMatch": [".devkit.json", ".devkitrc"],
      "url": "node_modules/scaffolder-toolkit/devkit-schema.json"
    }
  ]
}

Option 3: Offline Schema

If you prefer to have the schema available offline, you can download the JSON file and link to it locally. This ensures autocompletion and validation work even without an internet connection.

• Download the schema: Save the file from the URL provided above (devkit-schema.json) to a permanent location on your computer.
• Update your IDE settings: In your settings.json, replace the url with a local file path.

Example for macOS/Linux:

{
  "json.schemas": [
    {
      "fileMatch": [".devkit.json", ".devkitrc"],
      "url": "/Users/your-username/my-schemas/devkit-schema.json"
    }
  ]
}

Example for Windows:

{
  "json.schemas": [
    {
      "fileMatch": [".devkit.json", ".devkitrc"],
      "url": "C:\\Users\\your-username\\my-schemas\\devkit-schema.json"
    }
  ]
}

Creating a New Template (The Full Workflow)

Scaffolder allows you to create and use your own templates in three simple steps.

Step 1: Create the Template Project

First, build your template. This is a standard project directory containing all the files you want to use. You can use any type of project, from a simple boilerplate to a complex custom setup.

Step 2: Add the Template to Your Config

Once your template project is ready, use the dk config add command to register it with the CLI. This command adds the template's details to your .devkit.json file, making it available for use.

Note: All custom templates must be added under a supported language section (e.g., javascript, typescript, node) in your configuration file.

# Add a template from a local folder to your global config
dk config add js custom-js-app --description "My personal JavaScript boilerplate" --location /Users/myuser/projects/my-local-template --global

Step 3: Use the Template

After running the dk config add command, you can scaffold a new project from your template using dk new.

# Create a new project from the template we just added
dk new js my-awesome-project -t custom-js-app

🗺️ Roadmap & Future Features

This project is in its early stages. We're committed to building a comprehensive developer toolkit.

• Multi-Programming Language Support: We'll progressively add templates for various frameworks and ecosystems (e.g., Python, Ruby, Go, Rust).
• Advanced Documentation: Detailed guides on creating and managing custom templates, with examples for various frameworks.

We're always working to improve the Scaffolder CLI. For a complete list of planned features, bug fixes, and development tasks, please see our TODO list.

🤝 Contributing

We welcome contributions. Please see our Contribution Guide for details on how to get started.

📄 License

MIT

Copyright (c) 2025, WAFFEU Ivany Botrel Rayn Contact Ivany Botrel Rayn WAFFEU - [e-mail]