rk-create

RK Create — Initialize Codebase Knowledge Base

Create a new knowledge base from a git repository.

Input

• Git repository URL (HTTPS or SSH)

Process

Step 1: Clone the Repository

cd ~/.repo-knowledge/_repos/
git clone <git-url> <project-name>

Derive {project-name} from the repo URL (e.g., [email protected]:org/my-project.git -> my-project).

Step 2: Create Project Cache Structure

mkdir -p ~/.repo-knowledge/<project-name>/docs/

Step 3: Scan and Index

Launch an indexer Agent to scan the codebase:

Use the Agent tool with this prompt:

You are a Codebase Indexer Agent.

Codebase path: "~/.repo-knowledge/_repos/{project-name}/"
Cache path: "~/.repo-knowledge/{project-name}/"

## Your Task
Scan the entire codebase and generate documentation for every function and class.

## Rules for Document Granularity
- One document per function
- One document per class (if class < 200 lines)
- If class > 200 lines, split by method — one document per method
- If function > 100 lines, split by logical sections

## For Each Component, Generate:

```markdown
---
cached: {YYYY-MM-DD}
source: {relative/path/to/file.ext}
---

## [Function/Class Name]
**File:** [relative/path/to/file.ext]

### What It Does
[1-2 sentence explanation in English and Chinese]

### Code
```[language]
[actual code]

Parameters

• param_name (type): Description

Returns

• (type): Description

Usage Example

[practical working example]

Notes

• Caveats, edge cases, related functions

## Save Each Document
1. Organize by directory structure matching source:
   `~/.repo-knowledge/{project-name}/docs/{source-dir}/{kebab-case-name}.md`
2. After ALL docs are generated, create `_index.md`:
   ```markdown
   # {project-name} Knowledge Index

   - [component-name](docs/path/component-name.md) — English description（中文描述）

Scan Strategy

1. Use Glob to find all code files (*.ts, *.js, *.py, *.go, *.java, *.rs, etc.)
2. Skip: node_modules, .git, dist, build, vendor, pycache
3. Read each file
4. Extract functions and classes
5. Generate doc for each
6. Save to cache
7. Build _index.md