Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.98 KB

README.md

File metadata and controls

86 lines (60 loc) · 3.98 KB

@workleap/foundry

This project is a non-interactive command-line tool that allows users to quickly create customized copies of a template stored in a Git repository. By specifying the desired values for text tokens within the template, users can easily generate new files that incorporate their own content and configurations. The tool streamlines the process of creating new projects based on an existing template, saving time and effort while ensuring consistency and accuracy.

See @workleap/foundry --help:

Usage: @workleap/foundry [options] [command]

Foundry-CLI generator module

Options:
  -v, --version                        output the version number
  -h, --help                           display help for command

Commands:
  generate-host-application [options]  use the host-application template
  generate-remote-module [options]     use the remote-module template
  generate-static-module [options]     use the static-module template
  generate-web-application [options]   use the web-application template
  help [command]                       display help for command

Commands

generate-host-application

Use the host-application template as a base to customize with these options:

option description required
--out-dir where to create the template ✔
--package-scope package scope ✔
-h, --help display help for command

generate-remote-module

Use the remote-module template as a base to customize with these options:

option description required
--out-dir where to create the template ✔
--host-scope host scope ✔
--package-name package name ✔
-h, --help display help for command

generate-static-module

Use the static-module template as a base to customize with these options:

option description required
--out-dir where to create the template ✔
--host-scope host scope ✔
--package-name package name ✔
-h, --help display help for command

generate-web-application

Use the web-application template as a base to customize with these options:

option description required
--out-dir where to create the template ✔
--package-name package name ✔
--provider build provider (choices: "github", "azure", "none") ✔
--project-name project name
-h, --help display help for command

Develop

During development, we are using pnpm, this is the recommended tooling.

To test locally your development version, without the need to rebuild and install it continually, use this command:

pnpm dev

Then you can call the CLI as a global command from foundry.

Then to remove the link:

pnpm unlink