Create a new project

The @archibald/create package is a lightweight package to help you generate a project quickly. It comes with almost no dependencies to have you up and running in no time.

Installation

You don't need to install that package globally as it is designed to only bootstrap a template.

Bootstrap a new project from a selection of templates with any of the following commands.

npm init @archibald

npm create @archibald

pnpm create @archibald

Arguments

Argument	Description
target	Specify the folder the project will be bootstrapped in.

Options

Option	Description
-n, --name [name]	Specify the name of the project.
-a, --author [author]	Specify the author of the project.
-eml, --email [email]	Specify the email of the author.
-e, --environments [environments]	Specify environments of the project. Default: local.
-t, --tenants [tenants]	Specify tenants of the project. Default: netconomy.net.
-p, --platforms [platforms]	Specify platforms of the project. Default: shop.
-tpl, --template [template]	Specify which template should be used for bootstrapping. Possible values: basic shop
-o, --organization [organization]	Specify the registry url of the organization under which the project is located in Gitlab. Default: registry.gitlab.com/netconomy.
-g, --group [group]	Specify the name of the group under which the project is located in Gitlab.
-pr, --project [project]	Specify the name of the project in Gitlab. Usually this name matches the name defined in the package.json file.
-dcie, --defaultCiEnvironment [defaultCiEnvironment]	Specify the default environment to be used in the Gitlab CI.
-v, --version	Provide custom version to install.
-i, --install	Install dependencies. Default: false.
-g, --git	Initialize git repo.
-pm, --package-manager [packageManager]	Package Manager to use.
-o, --override	Override if folder already exists. Default: false.
-q, --quiet	Don't use interactive cli and run the command with default options. Default: false.
-h, --help	Show help commands.