https://github.com/crequency/cheese

A new generation of project scaffolding tool
https://github.com/crequency/cheese

auxiliary cheese developer-tools development scaffolding

Last synced: 2 months ago
JSON representation

A new generation of project scaffolding tool

• Host: GitHub
• URL: https://github.com/crequency/cheese
• Owner: Crequency
• License: agpl-3.0
• Created: 2024-02-02T11:10:41.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-09-27T01:19:00.000Z (4 months ago)
• Last Synced: 2024-10-28T12:52:03.979Z (3 months ago)
• Topics: auxiliary, cheese, developer-tools, development, scaffolding
• Language: C#
• Homepage:
• Size: 723 KB
• Stars: 8
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        



  

    

  



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:

```shell

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:

```shell

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:

```text

+ project

  + .cheese

  + src

  + docs

    README.md

    LICENSE

```

You can create this folder by `cheese init` command.

## Contributors

[![Contributors](https://contrib.rocks/image?repo=Crequency/Cheese)](https://github.com/Crequency/Cheese/graphs/contributors)

# Star History

[![Star History Chart](https://starchart.cc/Crequency/Cheese.svg?variant=adaptive)](https://starchart.cc/Crequency/Cheese)

# Thanks to



  

    

  





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