Examples

Every example calls the public methods of the CLDK Python SDK. The sample output is illustrative. The examples are grouped by task. They use the same sample projects as the rest of these docs: a generic my_pkg for Python, Apache Commons CLI for Java, a generic my_app for TypeScript and JavaScript, and the Quarkus Coffee Shop Helm chart for infrastructure-as-code.

One API, three languages

The Python, Java, and TypeScript pages follow the same pattern. First, the factory for the language builds the analysis (CLDK.java(project_path=...), CLDK.python(project_path=...), CLDK.typescript(project_path=...)). Then the analysis method for the task returns the result. JavaScript projects use the TypeScript factory. Infrastructure-as-code has no factory yet, so its page uses the caniac command, jq, and Cypher.

Python examples Symbol tables, call graphs, and the PyClass and PyCallable models.

Java examples Symbol tables, call graphs, callers and callees, class relationships, comments, entry points, and reachability, on Apache Commons CLI.

TypeScript examples Symbol tables, call graphs, interfaces, enums, decorators, and the TSClass and TSCallable models.

JavaScript examples The same TypeScript factory on a plain JavaScript project, and what differs.

Related pages

For the full method list instead of worked snippets, see the API reference. For the model behind them, see Core concepts.