Skip to content

frate-dev/frate-go

Repository files navigation

Let's create a README.md file with the provided content.

Frate-Go

Frate-Go is a command-line tool designed for efficient C/C++ project management. It simplifies building, managing dependencies, handling CMake configurations, and working with templates and package repositories.

Table of Contents


Installation

  1. Download and Install: Make sure you have Go installed on your system. Then, install frate-go using:

    go install github.com/frate-dev/frate-go@latest

Linux and Mac

curl https://raw.githubusercontent.com/frate-dev/frate-go/refs/heads/main/install.sh | bash

Usage

Available Command

  • build - Build the project using CMake.
  • completion - Generate the autocompletion script for the specified shell.
  • dependency - Manage your project dependencies.
  • generate - Generate or regenerate your project's configuration using CMake.
  • help - Display help information about any command.
  • init (alias: i) - Initialize a new Frate-Go project.
  • packages - Search and push your project to a package repository.
  • repo - Add, remove, or list package repositories.
  • run - Build and run your project.
  • template (alias: t) - Manage templates, create, list, delete templates, and manage template repositories.

Shell Completion

Zsh Completion

frate-go completion zsh > ~/.zsh-completions/_frate-go
echo "fpath=(~/.zsh-completions $fpath)" >> ~/.zshrc

Examples

frate-go init project
cd project
frate-go run 
frate-go template init new_template 
cd new_template
frate-go template push .
frate-go packages list 
frate-go packages push .