https://github.com/ewilde/crane

Crane creates builds scripts so you don't have to
https://github.com/ewilde/crane

Last synced: 3 months ago
JSON representation

Crane creates builds scripts so you don't have to

• Host: GitHub
• URL: https://github.com/ewilde/crane
• Owner: ewilde
• License: apache-2.0
• Created: 2014-03-19T13:03:16.000Z (about 12 years ago)
• Default Branch: develop
• Last Pushed: 2015-06-29T19:39:59.000Z (almost 11 years ago)
• Last Synced: 2025-12-20T10:46:06.407Z (6 months ago)
• Language: C#
• Homepage: http://blog.cranebuild.com
• Size: 10.9 MB
• Stars: 6
• Watchers: 4
• Forks: 2
• Open Issues: 46
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
crane [![Appveyor build status](https://ci.appveyor.com/api/projects/status/0ej0if13ux6nsc7h/branch/master?svg=true)](https://ci.appveyor.com/project/ewilde/crane/branch/master) [![Teamcity build status](https://img.shields.io/teamcity/http/teamcity.cranebuild.com/s/crane_Master.svg)](http://teamcity.cranebuild.com/viewType.html?buildTypeId=crane_Master) [![](http://img.shields.io/chocolatey/dt/crane.svg)](https://chocolatey.org/packages/crane) [![](http://img.shields.io/chocolatey/v/crane.svg)](https://chocolatey.org/packages/crane) [![Stories in Ready](https://badge.waffle.io/ewilde/crane.png?label=ready&title=Ready)](https://waffle.io/ewilde/crane) [![Stories in Progress](https://badge.waffle.io/ewilde/crane.png?label=in+progress&title=Progress)](https://waffle.io/ewilde/crane) [![Documentation Status](https://readthedocs.org/projects/crane/badge/?version=latest)](http://docs.cranebuild.com/) [![Documentation Status](https://scan.coverity.com/projects/3930/badge.svg)](https://scan.coverity.com/projects/3930) [![Follow cranebuild on twitter](doc/follow_crane_18.png)](https://twitter.com/cranebuild)

=====

[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/ewilde/crane?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

> Builds you into the pit of success



We hate writing build scripts and continuous integration (ci) templates every time

we start a new project or when we work on a project that does not have them. I'm sure you do as well. This is where `crane`comes in.

Invoke `crane` and it can build you a blank project, complete with a build or you can get `crane` to assemble you a build on an existing project.  No more messing around for hours on a build server!!

#Installation

To install crane, run the following command from the command line or from PowerShell:

`choco install crane`

![choco install crane](doc/choco_install_crane.png)

Don't have chocolatey installed? https://chocolatey.org/

#Please show me?

`crane init SallyFx`

This creates a new project called SallyFx in the current directory.

```

> crane init SallyFx

C:\DEV\TEMP\SALLYFX

|   build.ps1

|

+---build

|       default.ps1

|       NuGet.exe

|       psake-ext.psm1

|       psake.ps1

|       psake.psm1

|

\---src

    |   SallyFx.sln

    |

    +---.nuget

    |       packages.config

    |

    +---SallyFx

    |   |   Calculator.cs

    |   |   SallyFx.csproj

    |   |

    |   \---Properties

    |           AssemblyInfo.cs

    |

    \---SallyFx.UnitTests

        |   CalculatorFeature.cs

        |   packages.config

        |   SallyFx.UnitTests.csproj

        |

        \---Properties

                AssemblyInfo.cs

```

You can now build this project...

![example_build.png](doc/example_build.png)

#Supported commands

##init

`init` initializes a new project.

**Example**:

`crane init SallyFx` create a new project called 'SallyFx'

The default crane project is quite opinionated we have made lots of decisions.

Here are the highlights:

**Build**

* psake powershell build system

* restores nuget packages

* patches your assembly info files with information from VERSION.txt and

last git commit message, if it's a git repo

* builds

* runs unit tests

**Project template**

* Solution file with

* Class library

* Unit test library

 * Using xbehave, EasyFakes,  bdd style tests

##help

`help {command}` lists required and optional parameters for commands

**Example**:

`crane help init` show help for the init command