kickr

README

kickr

---

• How to use ?
  • Go
  • Linux
• Commands
  • Init
  • Generate
• Kickr file

How to use ?

Go

go install github.com/kickr-dev/kickr/cmd/kickr@latest

Linux

OS="linux" # change it depending on your case
ARCH="amd64" # change it depending on your case
INSTALL_DIR="$HOME/.local/bin" # change it depending on your case

new_version=$(curl -fsSL "https://api.github.com/repos/kickr-dev/kickr/releases/latest" | jq -r '.tag_name')
url="https://github.com/kickr-dev/kickr/releases/download/$new_version/kickr_${OS}_${ARCH}.tar.gz"
curl -fsSL "$url" | (mkdir -p "/tmp/kickr/$new_version" && cd "/tmp/kickr/$new_version" && tar -xz)
cp "/tmp/kickr/$new_version/kickr" "$INSTALL_DIR/kickr"

Commands

Kickr initializes or generates kickr projects. Kickr projects are only defined by a .kickr file
and multiple files automatically generated to avoid multiple hours to setup Continuous Integration, coverage, security analyzes, helm chart, etc.

Kickr generation can be done with 'kickr' command or 'kickr generate' command.

Usage:
  kickr [flags]
  kickr [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  generate    Generate project layout
  help        Help about any command
  init        Initialize new kickr project
  version     Show current version

Flags:
  -d, --dir string          set directory where generation will be made (default is current directory)
  -f, --force               force generation of all files initially created by kickr (README.md, SECURITY.md, etc.) even if the initial generated notice has been removed
  -h, --help                help for kickr
      --log-format string   set logging format (either "text" or "json") (default "text")
      --log-level string    set logging level (default "info")

Init

Initialize new kickr project

Usage:
  kickr init [flags]

Flags:
  -h, --help   help for init

Global Flags:
  -d, --dir string          set directory where generation will be made (default is current directory)
      --log-format string   set logging format (either "text" or "json") (default "text")
      --log-level string    set logging level (default "info")

Generate

Generate project layout

Usage:
  kickr generate [flags]

Flags:
  -f, --force   force generation of all files initially created by kickr (README.md, SECURITY.md, etc.) even if the initial generated notice has been removed
  -h, --help    help for generate

Global Flags:
  -d, --dir string          set directory where generation will be made (default is current directory)
      --log-format string   set logging format (either "text" or "json") (default "text")
      --log-level string    set logging level (default "info")

Kickr file

TBD