scratch

README

Usage demo • Installation • Command-line completion • Usage • Contributing • License

scratch is a simple utility for generating blank files for Go apps, utilities and packages.

Installation

From sources

To install the scratch from sources, make sure you have a working Go 1.19+ workspace (instructions), then:

go install github.com/essentialkaos/scratch

Command-line completion

You can generate completion for bash, zsh or fish shell.

Bash:

sudo scratch --completion=bash 1> /etc/bash_completion.d/scratch

ZSH:

sudo scratch --completion=zsh 1> /usr/share/zsh/site-functions/scratch

Fish:

sudo scratch --completion=fish 1> /usr/share/fish/vendor_completions.d/scratch.fish

Man documentation

You can generate man page for scratch using next command:

scratch --generate-man | sudo gzip > /usr/share/man/man1/scratch.1.gz

Usage

Usage: scratch {options} template dir

Options

  --no-color, -nc    Disable colors in output
  --help, -h         Show this help message
  --version, -v      Show version

Examples

  scratch package
  List files in template "package"

  scratch package .
  Generate files based on template "package" in current directory

  scratch service $GOPATH/src/github.com/essentialkaos/myapp
  Generate files based on template "service" in given directory

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0