skilld
All skills
gogf avatar

/goframe-v2

@911705d
by GoFramegogf/skills81 stars
3

GoFrame v2 development skill. Use only when the target Go project uses or is explicitly adopting GoFrame v2: the nearest go.mod requires github.com/gogf/gf/v2, existing Go files import github.com/gogf/gf/v2 or any github.com/gogf/gf/v2/... component package, or the user asks to scaffold, migrate, or build with GoFrame. Trigger for GoFrame-backed Go work such as APIs/controllers/services, middleware, routing/config, ORM/DAO/DO/entity/database operations, gf CLI/codegen, HTTP/gRPC services, and microservice conventions. Do not trigger for generic Go projects without GoFrame evidence, frontend-only work, shell scripts, or unrelated infrastructure tasks.

Ask your Agent

Use this Skill: https://skilld.dev/gh/gogf/skills/goframe-v2

This session only. Nothing lands on disk.

examplesconfigconsulREADME.MD

≈999 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Consul Configuration Center Example

Description

This directory contains an example demonstrating how to integrate Consul configuration center with GoFrame applications. It shows:

  1. Consul Client Configuration

    • Consul client setup and initialization
    • Configuration adapter implementation
    • Error handling and logging

  2. Configuration Management

    • Configuration loading and parsing
    • Dynamic configuration updates
    • Configuration value retrieval

Directory Structure

.
├── boot/           # Bootstrap configuration
│   └── boot.go     # Consul client initialization
├── main.go         # Main application entry
├── go.mod          # Go module file
└── go.sum          # Go module checksums

Requirements

Features

The example showcases the following features:

  1. Consul Integration

    • Client configuration
    • Connection management
    • Key-Value store access
    • Error handling

  2. Configuration Management

    • Configuration loading
    • Value retrieval
    • Type conversion
    • Default values

  3. Dynamic Updates

    • Configuration watching
    • Change notification
    • Hot reload support

Configuration

Consul Server

  1. Server Configuration:

    • Default port: 8500
    • Default datacenter: dc1
    • Default scheme: http

  2. Authentication:

    • Token-based authentication
    • ACL system support
    • Datacenter level isolation

Client Configuration

  1. Basic Settings:

    • Address: Consul server address
    • Scheme: HTTP/HTTPS
    • Datacenter: Configuration datacenter
    • Token: Access token

  2. Advanced Options:

    • Path customization
    • Watch configuration
    • Transport settings
    • Retry options

Usage

  1. Start Consul Server:

    # Start Consul server using Docker
docker run -d --name consul \
   -p 8500:8500 -p 8600:8600/udp \
   hashicorp/consul

  2. Configure Consul:

  3. Run Example:

    go run main.go

Implementation Details

  1. Client Setup (boot/boot.go):

    • Consul client configuration
    • Transport layer setup
    • Authentication configuration
    • Error handling

  2. Configuration Access (main.go):

    • Configuration availability check
    • Bulk configuration retrieval
    • Single value access
    • Error handling

Notes

  • The example uses Consul's Key-Value store for configuration management
  • Configuration changes in Consul are automatically reflected in the application
  • The client supports secure connections via HTTPS
  • ACL tokens can be used for secure access
  • Configuration paths can be customized based on needs

Source: SKILL.md on GitHub

Third-party checks

1 alert16d5 checks · Risk MEDIUM
  • Gen Agent Trust Hub16d

    The skill provides a comprehensive development guide and code examples for the GoFrame v2 framework. While highly informative for Go developers, it contains several examples with hardcoded placeholder secrets, tokens, and specific local file paths to sensitive configuration files (like Kubernetes credentials). These elements are provided for demonstration purposes but represent insecure practices if used in production without modification.

  • Socket16d

    5 alerts: gptSecurity, gptAnomaly

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer6mo

    227/949 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at 911705d. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 4 months ago.

Steadyupdated 4 months ago

Topics

  • Go
  • Database
  • goframe
  • orm
  • http
  • grpc
  • microservices
  • crud
  • scaffolding
  • middleware

README badge

README badge for gogf/skills

What it does

Provides instruction and conventions for developing with GoFrame v2, a modular Go framework for building HTTP and gRPC services, microservices, and database operations using its ORM, CLI tooling, and project scaffolding. Use this skill when the target project has GoFrame v2 as a dependency or when the user requests scaffolding, migrations, or service development with GoFrame conventions.

Generated from the current SKILL.md.

Frequently asked

When should I use this skill?
Use this skill only when your Go project uses GoFrame v2, indicated by github.com/gogf/gf/v2 in go.mod or imports. Do not use for generic Go projects, frontend work, or infrastructure tasks unrelated to GoFrame.
Should I manually set created_at and updated_at fields?
No. GoFrame automatically writes created_at on insert and updated_at on insert/update/save. Manually setting these fields is redundant and violates project conventions.
What should I use for database operations instead of g.Map?
Always use DO objects from internal/model/do/. DO struct fields are interface{}, unset fields remain nil and are automatically ignored by the ORM.
How does soft delete work in GoFrame?
Call Delete() on the DAO; GoFrame automatically converts it to UPDATE SET deleted_at = NOW(). Queries automatically filter out soft-deleted rows without requiring manual WhereNull conditions.
Where should I implement business logic?
Implement business logic directly in the service/ directory. Do not use the logic/ directory unless explicitly requested.

Generated from the current SKILL.md. These answers refresh after source changes.