Skip to content

Restructure the org profile README and remove dead links #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rahlk merged 1 commit into from
Aug 3, 2026
Merged

Restructure the org profile README and remove dead links #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 23 additions & 61 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,49 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/cldk-dark.png">
<source media="(prefers-color-scheme: light)" srcset="assets/cldk-light.png">
<img alt="Logo">
<img src="assets/cldk-light.png" alt="CodeLLM-DevKit">
</picture>

<p align='center'>
<a href="https://codellm-devkit.info">
<img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=for-the-badge" />
</a>
<a href="https://badge.fury.io/py/cldk">
<a href="https://pypi.org/project/cldk/">
<img src="https://img.shields.io/pypi/v/cldk?style=for-the-badge&label=CLDK&color=blue&logo=python" />
</a>
<!-- <a href="https://www.npmjs.com/package/@codellm-devkit/cldk">
<img src="https://img.shields.io/npm/v/@codellm-devkit/cldk?color=crimson&logo=npm&style=for-the-badge" />
</a> -->
<a href="https://arxiv.org/abs/2410.13007">
<img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=for-the-badge" />
</a>
<a href="https://opensource.org/licenses/Apache-2.0">
<a href="https://opensource.org/license/apache-2.0">
<img src="https://img.shields.io/badge/License-Apache%202.0-green?style=for-the-badge" />
</a>
</p>



<p align="center">
<strong>One analysis interface over every language: call graphs, symbol tables, and reachability — program analysis your agents can call.</strong>
</p>

<p align="center">
<a href="https://codellm-devkit.info"><strong>Documentation</strong></a> •
<a href="https://codellm-devkit.info/quickstart/"><strong>Quickstart</strong></a> •
<a href="https://github.com/orgs/codellm-devkit/discussions"><strong>Discussions</strong></a>
<a href="https://codellm-devkit.info">Documentation</a> |
<a href="https://codellm-devkit.info/quickstart/">Quickstart</a> |
<a href="https://github.com/orgs/codellm-devkit/discussions">Discussions</a>
</p>

CodeLLM-DevKit (CLDK) loads a codebase and hands you back a typed object model of it with classes, methods, fields, and call graphs (among other things) through **one consistent `analysis` object**. Instead of token-heavy crawls through files to answer questions like "what calls this method?" or "is this code reachable?", agents and developers can run precise, deterministic lookups against the actual program. The result is grounded answers from ground truth rather than approximations from grepping.

## Supported Languages

| Language | Status |
| -------- | ------ |
| **Java** | Full support — deepest analysis (class hierarchy, call graph, CRUD analysis) |
| **Python** | Strong support |
| **TypeScript** | Strong support |
| **Go, Rust, C** | In development |
Java, Python, and TypeScript are supported today, with Go, Rust, and C in development.

## Getting Started

Install the Python SDK (the Java backend is bundled — you only need a JDK on your `PATH` to analyze Java projects):
- 📚 Read the [Documentation](https://codellm-devkit.info) for guides, core concepts, and common tasks
- ✨ Browse usage [examples and tutorials](https://github.com/codellm-devkit/cldk-tutorial)
- 💻 Install the Python SDK and query your project:

```bash
pip install cldk
```

Build an analysis facade for your project and query the typed model:
The Java backend is bundled — you only need a JDK on your `PATH` to analyze Java projects.

```python
import os
Expand All @@ -69,51 +59,22 @@ print(len(analysis.get_classes()), "classes")
print(analysis.get_call_graph())
```

The same three-step workflow — construct a `CLDK` object for your language, build an `analysis` facade pointing at a project, then query — works across languages:

```python
from cldk import CLDK
from cldk.analysis import AnalysisLevel

analysis = CLDK(language="python").analysis(
project_path="my_pkg",
analysis_level=AnalysisLevel.call_graph,
)

print(len(analysis.get_classes()), "classes")
print(analysis.get_call_graph())
```

- 📚 Read the [Documentation](https://codellm-devkit.info) for guides, core concepts, and common tasks
- ✨ Browse usage [examples and tutorials](https://github.com/codellm-devkit/cldk-tutorial)

## Software Development Kits (SDKs)
Construct a `CLDK` object, build an `analysis` facade pointing at a project, then query it. Only the `language` argument changes across languages.

- [python-sdk](https://github.com/codellm-devkit/python-sdk) • official Python SDK ([`cldk` on PyPI](https://pypi.org/project/cldk/))
- [typescript-sdk](https://github.com/codellm-devkit/typescript-sdk) • official (experimental) TypeScript SDK ([`@codellm-devkit/cldk` on npm](https://www.npmjs.com/package/@codellm-devkit/cldk))
## Project Structure

## Language-Specific Analysis Backends

- [codeanalyzer-java](https://github.com/codellm-devkit/codeanalyzer-java) • static analysis for Java/JavaEE using WALA and JavaParser
- [codeanalyzer-python](https://github.com/codellm-devkit/codeanalyzer-python) • static analysis backend for Python
- [codeanalyzer-ts](https://github.com/codellm-devkit/codeanalyzer-ts) • static analysis backend for TypeScript/JavaScript
- [codeanalyzer-go](https://github.com/codellm-devkit/codeanalyzer-go) • static analysis engine for Go
- [codeanalyzer-rust](https://github.com/codellm-devkit/codeanalyzer-rust) • static analysis for Rust via the Rust compiler IR

## Build with CLDK

- [cocoa-py](https://github.com/codellm-devkit/cocoa-py) • the **Code Context Agent (COCOA)** and toolbox MCP server (Python). A Claude Code plugin that wraps CLDK so agents can query code structure -- callers, reachability, impact analysis rather than guessing.

## Documentation and Examples

- [Documentation](https://codellm-devkit.info) • guides, quickstart, core concepts, and a cheat sheet
- [cldk-tutorial](https://github.com/codellm-devkit/cldk-tutorial) • start building with CLDK
- [python-sdk](https://github.com/codellm-devkit/python-sdk) - official Python SDK ([`cldk` on PyPI](https://pypi.org/project/cldk/))
- [typescript-sdk](https://github.com/codellm-devkit/typescript-sdk) - official TypeScript SDK (experimental)
- [codeanalyzer-java](https://github.com/codellm-devkit/codeanalyzer-java) - static analysis for Java/JavaEE using WALA and JavaParser
- [codeanalyzer-python](https://github.com/codellm-devkit/codeanalyzer-python) - static analysis backend for Python
- [codeanalyzer-typescript](https://github.com/codellm-devkit/codeanalyzer-typescript) - static analysis backend for TypeScript/JavaScript
- [cldk-tutorial](https://github.com/codellm-devkit/cldk-tutorial) - start building with CLDK

## Contributing

We welcome contributions of all kinds! Whether you want to fix bugs, improve documentation, or propose new features, please see our [contributing guide](CONTRIBUTING.md) to get started.

Have questions? Join the discussion in our [community forum](https://github.com/orgs/codellm-devkit/discussions) or [Discord server](https://discord.com/channels/1333486179667935403/1334150434348208208).
Have questions? Join the discussion in our [community forum](https://github.com/orgs/codellm-devkit/discussions) or [Discord server](https://discord.gg/zEjz9YrmqN).

## Reference

Expand All @@ -127,6 +88,7 @@ To cite Codellm-Devkit, please use the following reference:
year={2024}
}
```

## IBM Public Repository Disclosure

Codellm-devkit is an open source project from [IBM Research](https://github.com/IBM) and open to contributions from the entire community. All content in these repositories including code has been provided by IBM under the associated open source software license and IBM is under no obligation to provide enhancements, updates, or support. IBM developers produced this code as an open source project (not as an IBM product), and IBM makes no assertions as to the level of quality nor security.
Expand All @@ -138,5 +100,5 @@ For any questions, feedback, or suggestions, please contact the authors:
| Name | Email |
| ---- | ----- |
| Rahul Krishna | [i.m.ralk@gmail.com](mailto:i.m.ralk@gmail.com) |
| Rangeet Pan | [rangeet.pan@ibm.com](mailto:rangeet.pan@gmail.com) |
| Saurabh Sihna | [sinhas@us.ibm.com](mailto:sinhas@us.ibm.com) |
| Rangeet Pan | [rangeet.pan@ibm.com](mailto:rangeet.pan@ibm.com) |
| Saurabh Sinha | [sinhas@us.ibm.com](mailto:sinhas@us.ibm.com) |