Sometimes, the most difficult thing is to just get started with a project. Cakecutter is a tool that helps you to cut the cake and start your amazing project instantly.
What Cakecutter does:
- Users can publish, create or use a cake from Cakes.run. Cakes are basically TOML files which contain all the information needed to create a project.
- According to the information in the
Cakefile, Cakecutter will create all the files and (you can also fill them with content) in the correct location. - Setup commands (installing dependencies, etc.) can be defined in the
Cakefile. These commands are run after the files are generated. - Cakecutter can ask questions to the user and take input. The input can then be used as variables for the project template. Read the docs here
- Read the Basic example cake and [/examples/Python.toml] the Python Cake to see how Cakes are written.
The cli is written in go, so if you have go installed run
go install github.com/cake-cutter/cc@latest
If you have npm you can install cakecutter by running
For Windows
npm install -g cakecutter
For MacOS
npm install -g cc-for-mac
For Linux
npm install -g cc-for-linux
Testing hasn't been done for
macOSandlinuxyet. Please create an issue if you find any bug.
Download the binary executables from bin/<your_os>.
cc help
You can find cakes for your use cases on Cakes.run. You can also publish cakes yourself.
Read the Docs to learn how to use the cli and how to create and publish cakes yourself.
Find cakes made by other users on Cakes.run
Cakecutter is completely open source. If you want to contribute, please create an issue on the appropriate repository and we will assign the task to someone (or you).
If you need any help, or want to ask questions, or suggest features, please head over to the Discussions tab
You can also join our Discord server where we have a community of developers ready to help you out.
