Ecreo Cli

Command line tool for importing assets, setting up Umbraco Cloud projects etc.

Getting Started

Ecreo Cli is a tool for working with Umbraco solutions at Ecreo. You can create a new solution for an Umbraco Cloud project, clone an existing, or add assets (css/js etc.) to an existing solution.

Prerequisites

You need to have nodejs, npm and git installed.

Installing

It's best to install globally. That way you can use the tool wherever you want to

npm install --global ecreo-cli

Usage

Check the version To see what version you have installed, in your command line of choice, type:

 ecreo version

This will output the current installed version.

Update the tool To update the CLI tool, in your command line of choice, type:

 ecreo update

This will uninstall the globally installed version of ecreo-cli, and install a new one globally, effectively updating the installed version.

Create new solution for Umbraco Cloud project

To create a new solution, in your command line of choice, type:

 ecreo cloud

This will start the tool, and prompt you for solution name, url to clone from Umbraco Cloud, and a url for the core librarys remote repository. You can also specify this, when you start the tool:

ecreo cloud MyProject https://myproject.scm.s1.umbraco.io/c72e616b-2857-4143-88b9-cf8f021c48dc.git https://[email protected]/ecreodev/MyProject/_git/MyProject 

Note, the remote for the core library must exist, and be empty. If not the tool will exit before doing anything. You can create repositories at https://dev.azure.com/ecreodev/, remember to add the entire Ecreo team.

The tool will then clone the project from Umbraco Cloud, create a Core project (class library), clone the baseline for assets, install npm dependencies and add to a solution file. It also initializes a git repository for you, with a default .gitignore file. So all you have to do is to add a remote for Core and Assets, and your are good to go.

Clone existing solution

To clone an exising solution (Core+Assets from VSTS or other), type:

 ecreo clone

or

 ecreo clone https://[email protected]/ecreodev/MyProject/_git/MyProject

The tool will then clone the repository, install npm dependencies, and clone an eventual Umbraco Cloud solution.

Add Assets folder to existing solution To add assets folder (with css/js/svg, and default gulp setup) to an existing solution, navigate to the root directory of the solution and type:

 ecreo assets

The tool will find the directorys solution file (if there is more, you will be prompted for the right one), clone the baseline for assets, install npm dependencies and add the assets to your solution file. Afterwards the remote containing the assets baseline folder is removed. A way to update the assets folder is maybe coming in the future.

Add ModelsBuilder project to existing solution To add ModelsBuilder project (.net SDK project targeted at .net framework 4.7.2) to an existing solution, navigate to the root directory of the solution and type:

 ecreo models

The tool will find the directorys solution file (if there is more, you will be prompted for the right one), add a project for modelsbuilder models, and include it in the solution file.

Note, this project only works with the Embedded Models Builder version introduced in Umbraco 8.5.