Generate Repository Wiki

RepoWiki analyzes a code repository and generates structured Wiki documentation through the qodercli wiki command.

Prerequisites

Complete sign-in and authentication. You can sign in through qodercli or set QODER_PERSONAL_ACCESS_TOKEN. For details, see Sign-in and Authentication.
Ensure that your machine can access Qoder services. The first run prepares the required Wiki component, and Wiki generation requires network access.

Quick Start

Run the following command in the root directory of the target repository:

qodercli wiki

On the first run, Qoder CLI automatically prepares the required component before starting Wiki generation. On subsequent runs, it checks the officially supported version and updates the component when necessary. No separate installation or update command is required.

Common Options

# Generate a Wiki for a specific repository
qodercli wiki --repo /path/to/repo

# Generate English and Chinese documentation
qodercli wiki --language en,zh

# Generate a Wiki for a specific branch
qodercli wiki --branch develop

# Discard reusable Wiki data and regenerate from scratch
qodercli wiki --regenerate

Option	Description
`--repo <path>`	Target repository path. Specify this option multiple times to process multiple repositories.
`--language <languages>`	Comma-separated output languages, such as `en,zh`.
`--branch <branch>`	Git branch to process. If omitted, the current `HEAD` branch is used.
`--regenerate`	Regenerate from scratch. Existing reusable Wiki data is deleted.
`--help`	Display the options supported by the installed Wiki component.

Options after wiki are passed to the Wiki component. Run qodercli wiki --help to view the options supported by the current version.

Specify the Working Directory

By default, RepoWiki uses the current working directory. To select another workspace at the Qoder CLI level, place --cwd or --workspace before wiki:

qodercli --cwd /path/to/repo wiki
qodercli --workspace /path/to/repo wiki

You can also place --repo after wiki to select one or more target repositories.

Network and Proxy

Qoder CLI forwards common proxy and certificate environment variables when running RepoWiki, including HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, NO_PROXY, and NODE_EXTRA_CA_CERTS. If component preparation, automatic update, authentication, or Wiki generation fails in a restricted network environment, verify the proxy and certificate configuration. For details, see Network, Proxy, and VPC Issues.

FAQ

Why is qodercli wiki unavailable? Update Qoder CLI to the latest version, verify network access, and run qodercli --help again. Why did authentication fail? Ensure that you are signed in or that QODER_PERSONAL_ACCESS_TOKEN is set correctly. For details, see Sign-in and Authentication Issues. Why did component preparation or automatic update fail? Check your network, proxy, and certificate settings, then run qodercli wiki again. If a usable version is already installed, Qoder CLI can continue using it when the version check is temporarily unavailable. How do I update the Wiki component? Run qodercli wiki. Qoder CLI checks and applies the officially supported version automatically. How do I rebuild an existing Wiki from scratch? Run qodercli wiki --regenerate. This removes existing reusable Wiki data before generation.

Next Steps

Sign-in and tokens: Sign-in and Authentication.
Network and proxy configuration: Network, Proxy, and VPC.
Command-line startup arguments: CLI Commands and Parameters.