company-wiki-reader

Read-only, agent-friendly local wiki synchronization. Node.js 22+ and Git 2.39+ required (use a maintained Git release). Repository must use HTTPS; large media should be stored in Git LFS. No Git LFS client or persistent LFS media cache is required on the reader computer.

Install and update

npm install -g company-wiki-reader@latest
wiki-reader doctor --json

Git missing or not on PATH

Do not search the entire disk. doctor checks explicit WIKI_READER_GIT, managed MinGit, PATH and standard Windows installation locations with bounded probes. It reports gitPath, a version, or a structured error plus next command. Missing Git is detected before a new Wiki directory is created.

wiki-reader setup --json
wiki-reader setup --apply --json
wiki-reader doctor --json

On Windows, setup reuses usable Git, otherwise installs pinned official MinGit 2.55.0.windows.3 for the native x64/ARM64/x86 architecture in %LOCALAPPDATA%/company-wiki-reader/runtimes. No admin rights, GitHub login, global PATH modification or Git LFS client are required. --apply is mandatory to download/install. Auto source selection tries Huawei Cloud then GitHub, with fixed official SHA256 checks, 15-second idle / 120-second per-source limits and no retries beyond those two attempts. Hash/size mismatch stops installation. --source official|huawei selects one source. Archives are retained at the reported path; no unrelated files are overwritten. Downloads use direct HTTPS with TLS verification; corporate-proxy-only networks require administrator review. See the dependency branch for sources and failure handling.

On macOS setup only reports a supported package-manager installation step. Node must already be accessible to the Agent shell; this CLI cannot bootstrap the runtime needed to launch itself. Once setup/doctor passes, continue the original download/update command. There is no postinstall hook and no automatic network-access grant.

Repeat the npm install command before company updates to obtain current centrally managed connection metadata. No postinstall access, credentials or VPN configuration is installed. The owner-approved company repository address is public in this package; content and credentials are not bundled. It remains reachable only through the authorized company network/VPN.

Company employee commands

wiki-reader download --apply --json
wiki-reader update --apply --json

Both default to company-wiki in the current user's home; an optional folder argument selects a different local destination. No URL, password, CA or profile input is needed. download resumes existing managed company copies. update safely migrates recognized old endpoints and removes their local custom CA setting after backup, verifies repository history continuity and preserves local edits. Non-minimal/unknown copies require administrator review. TLS remains enabled. Only the current process bypasses proxies for the company endpoint; no global proxy, VPN or route settings change. Automatic VPN setup is not implemented.

Maintainers update src/company.mjs, retain previous endpoints in its allowlist, increment the package version and publish to latest. Installed older versions do not magically receive changed settings: employees' Agents must upgrade the package first. wiki-reader company --json exposes diagnostic metadata. Generic commands below remain available.

First download

wiki-reader init ./local-wiki --url https://git.example.org/team/wiki.git --profile minimal --apply

For an organization CA, add --ca /path/to/public-ca.crt. Obtain the URL and CA from your administrator; never disable certificate verification. Authentication-required repositories are not yet supported. Your existing network/VPN must already reach the server.

minimal includes searchable text and local attachments referenced in published Markdown notes; video, audio, archives and build-working folders are excluded. Raw text is retained but raw scraped galleries do not automatically bring every source image. Dynamic links and ambiguous wiki-style filenames are not fully resolved; review expected attachments. no-video retains all non-video files and can be larger.

Update

wiki-reader plan ./local-wiki --json
wiki-reader sync ./local-wiki --apply --json
wiki-reader status ./local-wiki --json

Local edits cause conflicts and are preserved. Remote deletions currently require review. Downloads are hash-checked; completed files can be recognized on retry. Incomplete files restart from the beginning, not HTTP byte-range resume. One temporary download is used at a time; replaced-file backups are retained locally and may require reviewed cleanup. Updates are file-by-file, not a whole-tree atomic transaction. Git object metadata is retained, so large ordinary Git blobs can still use storage: put source media in LFS.

Agents

wiki-reader skill source
wiki-reader skill install --target /path/to/agent/skills/wiki-reader --apply
wiki-reader skill status --target /path/to/agent/skills/wiki-reader

The CLI package is the single source of truth. Skill installs are links/junctions; unrelated existing skill folders are never overwritten. Use the Agent's documented skill directory. Codex and SealSeek instruction adapters are implemented, not yet clean-regression tested. Accio integration is unresolved pending its runtime contract. Any permitted terminal-capable Agent can invoke the CLI without native integration.

Scope: anonymous HTTPS read; no push, administrative changes, credentials provisioning, or general-purpose backup. Public distribution is not a grant of access to any company's wiki. The package is currently marked UNLICENSED; no open-source license grant is implied. Version 0.4.0 has automated macOS CLI and simulated Windows discovery/failure tests. Real Windows MinGit installation and clean Agent regression remain separate acceptance gates; do not infer those passes from unit tests.