MCPcopy Index your code
hub / github.com/FSoft-AI4Code/CodeWiki / generate_command

Function generate_command

codewiki/cli/commands/generate.py:310–621  ·  view source on GitHub ↗

Generate comprehensive documentation for a code repository. Analyzes the current repository and generates documentation using LLM-powered analysis. Documentation is output to ./docs/ by default. Examples: \b # Basic generation $ codewiki generate

(
    ctx,
    output: str,
    create_branch: bool,
    github_pages: bool,
    no_cache: bool,
    include: Optional[str],
    exclude: Optional[str],
    focus: Optional[str],
    doc_type: Optional[str],
    instructions: Optional[str],
    verbose: bool,
    max_tokens: Optional[int],
    max_token_per_module: Optional[int],
    max_token_per_leaf_module: Optional[int],
    max_depth: Optional[int],
    update: bool = False,
    compare_to: Optional[str] = None
)

Source from the content-addressed store, hash-verified

308)
309@click.pass_context
310def generate_command(
311 ctx,
312 output: str,
313 create_branch: bool,
314 github_pages: bool,
315 no_cache: bool,
316 include: Optional[str],
317 exclude: Optional[str],
318 focus: Optional[str],
319 doc_type: Optional[str],
320 instructions: Optional[str],
321 verbose: bool,
322 max_tokens: Optional[int],
323 max_token_per_module: Optional[int],
324 max_token_per_leaf_module: Optional[int],
325 max_depth: Optional[int],
326 update: bool = False,
327 compare_to: Optional[str] = None
328):
329 """
330 Generate comprehensive documentation for a code repository.
331
332 Analyzes the current repository and generates documentation using LLM-powered
333 analysis. Documentation is output to ./docs/ by default.
334
335 Examples:
336
337 \b
338 # Basic generation
339 $ codewiki generate
340
341 \b
342 # With git branch creation and GitHub Pages
343 $ codewiki generate --create-branch --github-pages
344
345 \b
346 # Force full regeneration
347 $ codewiki generate --no-cache
348
349 \b
350 # C# project: only .cs files, exclude tests
351 $ codewiki generate --include "*.cs" --exclude "*Tests*,*Specs*"
352
353 \b
354 # Focus on specific modules with architecture docs
355 $ codewiki generate --focus "src/core,src/api" --doc-type architecture
356
357 \b
358 # Custom instructions
359 $ codewiki generate --instructions "Focus on public APIs and include usage examples"
360
361 \b
362 # Override max tokens for this generation
363 $ codewiki generate --max-tokens 16384
364
365 \b
366 # Set all max token limits
367 $ codewiki generate --max-tokens 32768 --max-token-per-module 40000 --max-token-per-leaf-module 20000

Callers

nothing calls this directly

Calls 15

loadMethod · 0.95
is_configuredMethod · 0.95
get_configMethod · 0.95
get_api_keyMethod · 0.95
is_emptyMethod · 0.95
to_dictMethod · 0.95
generateMethod · 0.95
create_loggerFunction · 0.90
ConfigManagerClass · 0.90
ConfigurationErrorClass · 0.90

Tested by

no test coverage detected