@kustomer/apps-cli
v3.0.5
Published
[Documentation](https://developer.kustomer.com/kustomer-apps-platform/v0.1-Apps-SDK/docs/cli-introduction)
Downloads
202
Maintainers
Keywords
Readme
@kustomer/apps-cli
The command line interface is used to generate Kustomer apps that use the SDK. It will also register those apps with the Kustomer platform and generate the appropriate app tokens.
Usage
The following command will scaffold a basic app for you to build upon so you can quickly get started developing:
$: npx @kustomer/apps-cli new <your_desired_app_name>
If you want to test this command locally, you'll want to yarn build
the entire codebase from root, cd
into this folder, and run node ./dist/index.js new <your_desired_app_name>
.
Development
While there are a series of folders in this package, the main ones are:
commands
- The commands that are available to the CLIservices
- How those commands interact with the various Kustomer API'stemplates
- The templates that are used to scaffold the app