Skip to main content

Module api_surface

Module api_surface 

Source
Expand description

API Surface command - Extract machine-readable API surface (structural contracts).

Extracts the complete public API surface of a library or package, including:

  • Function and method signatures with typed parameters
  • Class definitions with constructor signatures
  • Constants and type aliases
  • Usage examples (templated from types)
  • Trigger keywords for intent-based retrieval

§Usage

# Extract API surface for an installed Python package
tldr surface json --lang python --format json

# Extract from a directory
tldr surface ./src/mylib/ --format text

# Look up a specific API
tldr surface json --lookup json.loads --format text

Structs§

ApiSurfaceArgs
Extract machine-readable API surface (structural contracts) for a library/package