https://github.com/kickr-dev/kickr
Kickr CLI for easy project kickstart generation
https://github.com/kickr-dev/kickr
generator golang layout repository-tools templates
Last synced: 3 months ago
JSON representation
Kickr CLI for easy project kickstart generation
- Host: GitHub
- URL: https://github.com/kickr-dev/kickr
- Owner: kickr-dev
- License: apache-2.0
- Created: 2025-08-15T17:57:31.000Z (11 months ago)
- Default Branch: beta
- Last Pushed: 2026-04-06T10:41:41.000Z (3 months ago)
- Last Synced: 2026-04-06T11:26:39.128Z (3 months ago)
- Topics: generator, golang, layout, repository-tools, templates
- Language: Go
- Homepage:
- Size: 5.09 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# kickr
---
- [How to use ?](#how-to-use-)
- [Go](#go)
- [Linux](#linux)
- [Commands](#commands)
- [Init](#init)
- [Generate](#generate)
- [Kickr file](#kickr-file)
## How to use ?
### Go
```sh
go install github.com/kickr-dev/kickr/cmd/kickr@latest
```
### Linux
```sh
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