Skip to content

MAKEFILE.md

Latest commit

 

History

History
134 lines (103 loc) · 2.38 KB

MAKEFILE.md

File metadata and controls

134 lines (103 loc) · 2.38 KB

SysCapture Make Commands

Overview

This document describes the available make commands for building, running, and maintaining the SysCapture application.

Basic Commands

Build and Run

# Build the application
make build

# Start the application (builds first)
make start

# Run in development mode
make dev

Development Tools

# Install project dependencies
make install

# Check application version
make version

# Clean build artifacts
make clean

Documentation

API Documentation

# Generate Swagger documentation
make docs

Code Quality

Testing

# Run all tests
make test

Code Maintenance

# Format code
make fmt

# Run linter
make lint

# Check for potential errors
make vet

# Run all code quality checks
make check

Command Details

Build Commands

  • build: Compiles the application to dist/syscapture
  • start: Builds and runs the compiled application
  • dev: Runs the application directly using go run

Dependency Management

  • install: Installs project dependencies
  • deps: Alternative command for dependency installation
    • Updates Swagger dependencies
    • Runs go mod tidy

Documentation

  • docs: Generates OpenAPI/Swagger documentation
    • Output directory: docs/
    • Processes API endpoints

Testing and Quality

  • test: Runs all project tests
  • fmt: Formats Go code using gofmt
  • lint: Runs golint for code style checks
  • vet: Runs go vet to check for common errors
  • check: Runs all code quality checks (fmt, lint, vet)

Utility Commands

  • version: Displays the current version
  • clean: Removes build artifacts and documentation

Directory Structure

syscapture/
├── dist/           # Build output
├── client/         # Client application code
├── docs/           # Generated Swagger docs
└── api/            # API definitions

Examples

Development Workflow

# Install dependencies
make install

# Run in development mode
make dev

Build and Deploy

# Run all checks
make check

# Run tests
make test

# Build for deployment
make build

Documentation Update

# Generate fresh documentation
make docs

Notes

  • Commands use @ prefix for cleaner output
  • Most commands include status messages
  • Build artifacts are placed in dist/ directory
  • Documentation is auto-generated from API code