Sig FAQs

Question 1

What kind of output does Sig provide?

Accepted Answer

Sig generates a compact JSON object (`FileShape`) detailing the file path, package, imports, and arrays of extracted types, functions, constants, and variables, including their names, signatures, and line numbers.

Question 2

Can Sig extract private or unexported symbols as well?

Accepted Answer

Yes, while Sig defaults to extracting only public API surface, it provides an option (e.g., `--all` in CLI mode) to include private or unexported symbols for a more comprehensive analysis of your codebase.

Question 3

How can I use Sig to analyze my code?

Accepted Answer

Sig operates in two primary modes: as a command-line interface (CLI) tool for one-off analyses, or as an MCP JSON-RPC stdio server, allowing integration with other tools like Claude Code for continuous or programmatic analysis.

Question 4

What is Sig and what does it do?

Accepted Answer

Sig is a developer tool that extracts the public API surface from source code files. It identifies function signatures, type definitions (structs, interfaces), constants, and variables, then outputs this information as compact JSON, excluding implementation bodies.

Question 5

Which programming languages does Sig support?

Accepted Answer

Sig currently supports Go (`.go`), TypeScript (`.ts`, `.tsx`, `.mts`, `.cts`), and C# (`.cs`) source files for API extraction.

Sig

Sig

主な機能

ユースケース

主な機能

ユースケース