cli

README

SAC (Student Activity Calendar) CLI

Introduction

The SAC CLI is a tool designed to help manage and automate tasks for the GenerateNU Student Activity Calendar platform. It provides a comprehensive suite of commands for formatting, testing, linting, running, and managing databases and other configurations essential for the SAC platform.

Table of Contents

1. Installation
2. Usage
3. Available Commands
4. Command Aliases
5. Dependencies

Installation

To install the SAC CLI, clone the repository and run the following script from the root of the application:

./install_cli.sh

Usage

To use the SAC CLI, you can run it with various flags or commands:

sac [flags]
sac [command]

Available Commands

• completion: Generate the autocompletion script for the specified shell.
• database: Database management commands.
• format: Formatting commands.
• help: Help about any command.
• lint: Linting commands.
• run: Run commands for backend and frontend.
• setup: Installs and sets up the project. (WIP)
• swagger: Run swagger initialization for backend openapi spec.
• test: Testing commands.

For more detailed information about a command, use:

sac [command] --help

Command Aliases

Several commands in the SAC CLI are equipped with short aliases to make them quicker and easier to use. For example, a command like sac format frontend dashboard which is pretty lengthy can be shortened to sac f fe d.

Dependencies

• golangci-lint: A linter aggregator for Go, ensuring code quality.
• gofumpt: A stricter formatter for Go code, ensuring consistency.