cercano-document

Generate Go doc comments for exported symbols using a local AI model.

Updated Mar 20, 2026
One-click install
npx skills add https://github.com/GoogleDevRelExplorations/cercano --skill cercano-document-googledevrelexplorations
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cercano-document
Source: https://github.com/GoogleDevRelExplorations/cercano/tree/main/.agents/skills/cercano-document
Command: npx skills add https://github.com/GoogleDevRelExplorations/cercano --skill cercano-document-googledevrelexplorations

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates Go doc comments for exported symbols using a local AI model and writes them back to the source file, preserving privacy by never sending contents externally.

Core Features & Use Cases

  • Generates missing or updated Go doc comments for functions, methods, types, interfaces, and constants using a local model.
  • Formats changes with gofmt and backs up originals to prevent data loss.
  • Use Case: Onboard a new Go project by automatically documenting public APIs in each file, improving readability and maintainability without external services.

Quick Start

Provide the path to a Go source file and let Cercano generate and insert the appropriate doc comments for exported symbols.

Frequently Asked Questions about cercano-document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Go doc comments for exported symbols locally?

To generate Go doc comments locally, you provide a Go source file path to a local AI model which then inserts missing or updated documentation for exported symbols directly in-place. This process keeps code private by avoiding external services.

Can I automatically document public APIs in a Go project without sending code externally?

You can automatically document public APIs without sending code externally by using a local AI model to generate doc comments. The tool writes these comments directly into your Go files during development or onboarding to improve maintainability.

What is the best way to add missing doc comments to Go functions and types?

The best way to add missing doc comments to Go functions and types is using a local AI generator. It analyzes exported symbols like functions, methods, interfaces, and constants, then automatically formats and inserts the documentation in-file.

Does generating Go doc comments in-place modify my original source files?

Generating Go doc comments in-place modifies source files but automatically creates backups of originals to prevent data loss. It also validates results and applies gofmt formatting before writing changes back to the file.

Do I need a local AI model to generate Go documentation for my codebase?

You need a local AI model to generate Go documentation if you require strict privacy and cannot send code to external services. This local approach processes files directly to document exported symbols while maintaining data confidentiality.