outfit-local-template-cli
v0.0.3
Published
Command-line interface for creating local templates with shared config and pushing local files to Outfit.
Downloads
8
Readme
Outfit Local Template CLI
A simple node command-line interface (CLI) for:
- Creating new templates locally on your machine
- Pushing local template files to an Outfit account
Requirements
- You must have node installed on your machine
- You must have git installed on your machine
Installation
Install the NPM package globally
npm install --global outfit-local-template-cli
Creating a new template
To create a new template, run the following command:
outfit-local-template new [template-name]
This will clone the local template boilerplate and install all dependencies automatically.
Start
To start the development server, run the following command:
outfit-local-template start
Set Access Key
To push files from your machine to an Outfit account, you first need to generate an access key. You can do this by logging into your Outfit account and navigating to your account settings page.
After you have created your access key, run the following command:
outfit-local-template setAccessKey [yourAccessKey]
Note: This is not required to develop templates locally. You just won't be able to push the files to Outfit automatically.
Get Access Key
To check what your access key is, you can run the following command:
outfit-local-template getAccessKey
Build
To build production ready files on your machine, run the following command:
outfit-local-template build
Deploying to Outfit
To deploy your production files to an Outfit account, run the following command:
outfit-local-template deploy [templateID] [subdomain]
Note: This command requires an access key to be set on your machine.
Help
You can run outfit-local-template --help
for a full list of commands.