Generating a Repo Wiki

The wiki command is currently not yet available in the Qoder CLI CN edition; running qodercn wiki reports that the command does not exist. This page is provided so you can learn about the feature in advance — once it becomes available in the CN edition, you can use it as described here.

RepoWiki generates wiki documentation for your code repository locally through the qodercn wiki subcommand. The entire generation process happens locally, and your code never leaves your machine. wiki is an external command: it is not bundled with the main program. On first use, the tool for your platform is downloaded on demand from the official distribution source and installed locally; after that it runs directly on your machine.

Prerequisites

You have signed in. The wiki command requires authentication, which can be provided by signing in via qodercn or by setting QODERCN_PERSONAL_ACCESS_TOKEN — see Sign-in and Authentication.
Network access is needed on first use to download the wiki tool (only the tool itself is downloaded; no code is uploaded).

Quick start

Run in the root of the target repository:

qodercn wiki

On first run, the CLI downloads and installs the tool automatically, then starts generating a wiki for the repository in the current directory.

Passing arguments

All arguments after wiki are passed through verbatim to the underlying wiki tool:

qodercn wiki [arguments supported by the tool...]

Which arguments the underlying tool supports (such as output location and language) is defined by the tool itself. Refer to its help output:

qodercn wiki --help

Specifying the working directory

By default the wiki is generated for the repository at the current working directory (process.cwd()). To target another directory, use --cwd or --workspace before wiki:

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

Mind the position: working-directory flags placed before wiki are parsed by the CLI; arguments placed after wiki are passed through to the underlying tool.

Installation and version management

The wiki tool is managed automatically by the CLI's external command mechanism: on first use of qodercn wiki it is downloaded and installed on demand, with versions obtained from the remote registry — no manual installation or updates required. Installed content lives under external-commands/wiki/ in the global config directory, kept per version. To customize or disable the registry source, see the environment variables under Network and proxy below.

Your code never leaves your machine

Wiki generation is a local operation: after download and installation, the wiki tool reads the repository on your local filesystem and generates the documentation without uploading repository code. The network is used only for downloading the tool itself and for necessary authentication.

Network and proxy

Downloading the tool follows your system network settings. The CLI passes common proxy and certificate environment variables through to external commands, including HTTP_PROXY, HTTPS_PROXY, NO_PROXY, and NODE_EXTRA_CA_CERTS. For troubleshooting in restricted networks, see Network, Proxy, and VPC Issues. To customize or disable the registry source, use these environment variables:

QODER_EXTERNAL_COMMAND_REGISTRY_URL — override the registry URL; set to off/none/false/0 to disable remote refresh.
QODER_EXTERNAL_COMMAND_REGISTRY_FILE — load the registry from a local file.

Note: these two variables do not vary by edition — the CN edition also uses the QODER_ prefix (not QODERCN_).

FAQ

Typing qodercn wiki says the command doesn't exist? The command is currently not available in the CN edition (see the note at the top of this page) — this is expected. Once it becomes available, update the CLI to the latest version to use it; run qodercn --help to check whether wiki appears in the command list. Authentication failure? Confirm you are signed in, or that QODERCN_PERSONAL_ACCESS_TOKEN is set correctly (make sure there are no leading or trailing spaces around the token). See Sign-in and Authentication Issues. Download fails on first run? Check your network and proxy settings, configure the proxy environment variables above if needed, and retry; to adjust the registry source, use the QODER_EXTERNAL_COMMAND_REGISTRY_URL / QODER_EXTERNAL_COMMAND_REGISTRY_FILE environment variables (see above). How do I update the wiki tool version? The wiki version is obtained automatically by the external command mechanism from the remote registry — usually no manual action is needed. To control the registry source or disable remote refresh, use the QODER_EXTERNAL_COMMAND_REGISTRY_URL / QODER_EXTERNAL_COMMAND_REGISTRY_FILE environment variables above.

Next steps

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