Skip to main content

edk init

$ edk init [options]

Description#

Generate a new ELARA workspace, containing elara.json project asset config, dependencies and initial project structure.

Options#

OptionDescription
--nameThe name of the solution, this will be defined within the elara.json config file.
--dirThe dir for the of the solution, if not specified the project will be created within a new ./name/
--helpDisplay the help for command.

Examples#

To view the help:

$ edk init --helpUsage: edk init [options]
initialise a new ELARA project
Options:  --name <name>  the name of the project (default: "...")  --dir <dir>    the path for the project directory (default: "...")  -h, --help     display help for command

To create a project within the current working directory:

$ edk init --name "Example Business" --dir .$ ls -mpelara.json, node_modules/, package.json, package-lock.json, schema.json, src/, tsconfig.json

To create a project within a new target directory:

$ edk init --name "Another Example Business" --dir example$ ls -mp example/elara.json, node_modules/, package.json, package-lock.json, schema.json, src/, tsconfig.json