README.md

Cheese

About

A new generation of project scaffolding tool to make your development process more effective with half the effort.

Installation

Install Cheese by dotnet tool:

dotnet tool install --global Cheese

Usage

Initialize (In Design)

Verb: init

You can use init command from Cheese to clone a repo and setup it.

For example:

cheese init Crequency/KitX.github
# We use protocol suffix including "github", "gitlab", "gitee"
# The default protocol is github, so you can execute: `cheese setup Crequency/KitX`

This command will clone Crequency/KitX repo from github, and check if there is .cheese folder.

With .cheese folder exists, the init action will be execute automatically.

In any folder, execute pure cheese init will only create .cheese folder.

Setup

Verb: setup

• --reference [bool]: include this argument to setup reference
  • cheese setup --reference = cheese reference --setup

Reference

Verb: reference, Alias: [ refer, ref ]

• --status [bool]: use this to show references status
• --update [bool]: use this to update references
  • --fetch [bool]: include this to fetch remote
• --setup [bool]: use this to setup references
  • --convert-ssl-link-to-https-link [bool]: include this to clone with https styled link
• --gen [bool]: use this to generate references.json file
  • --flavor [string]: select a reference flavor to generate

Publish

Verb: publish

• --skip-generate [bool]: include this to skip generation
• --skip-packing [bool]: include this to skip packing

i18n

Verb: i18n

• --target [string]: indicate the target

ToDo Commands

• commit
• doctor
• test
• docs
• config

Update your project

Your repo should have a .cheese folder in the root directory like:

+ project
  + .cheese
  + src
  + docs
    README.md
    LICENSE

You can create this folder by cheese init command.

Contributors

Star History

Thanks to

Thanks to the great tools from JetBrains, we can turn our ideas into reality.