Skip to content

Cli

short description: Propulates an empty Git repository with the most common files and folders as a starting point.
detailed description: |
  Propulates an empty Git repository with the most common files and folders as a starting point.
  Initializes repositories for the following programming languages: C++, Go, and Java.
  Supports these types of projects: embedded (and systems development), library, service, and tool (CLI).
  Also generates CI/CD files for GitHub or GitLab.

  These are the supported combinations:

  | Language | CLI Tool | Embedded | Library | Service |
  | -------- | -------- | -------- | ------- | ------- |
  | C++      | X        | X        | X       | X       |
  | Go       | X        |          | X       | X       |
  | Java     |          |          | X       | X       |

  Search for TODO markers once your repository has been populated.
options:
  - long: language
    short: l
    default: go
    description: Determine your target language. One of cpp, go, or java.
  - long: projecttype
    short: p
    default: service
    description: Determine your target project type. One of embedded, library, service, or tool (CLI).
  - long: ci
    short: c
    default: gitlab
    description: Optionally determine your target CI/CD tool. Either github or gitlab. Researched from local Git repository if option is absent.
  - long: name
    short: n
    default: null
    description: Human readable name of the project.
  - long: description
    short: d
    default: null
    description: Brief description of the project.
  - long: targetpath
    short: t
    default: null
    description: Target path referencing the (empty) repository folder to be initialized.
  - long: artifactname
    short: a
    default: null
    description: Optional technical artifact name, i.e. name of the executable or archive. Derived from local Git repository if option is absent.
  - long: modulepath
    short: m
    default: null
    description: Optional Go module path, e.g. gitlab.com/user/project. Derived from local Git repository if option is absent.