CLI Command to Verify Archify Installation: Complete Guide to the Doctor Check

Run node bin/archify.mjs doctor to execute Archify's built-in diagnostic routine and confirm your installation is healthy.

Before generating architecture diagrams, you should validate that your runtime environment meets all requirements. The tt-a1i/archify repository provides a dedicated CLI command to verify Archify installation, ensuring Node.js versions, dependencies, and internal configurations are correct. This diagnostic tool catches environment issues before they interrupt your workflow.

Running the CLI Command to Verify Archify Installation

The primary method to validate your setup is through the doctor subcommand. This tool performs comprehensive health checks on your environment and reports specific failures.

Basic Verification Syntax

Execute the following from your terminal:

node bin/archify.mjs doctor

This command invokes the main CLI entry point at archify/bin/archify.mjs and triggers the diagnostic routine documented in README_EN.md at line 208 and README_ZH.md at line 204.

What the Doctor Command Validates

According to the source code in archify/bin/archify.mjs, the verification routine checks four critical components:

• Node.js version compatibility — validates Node.js ≥ 18 is detected
• Required module availability — confirms all dependencies are resolvable
• ZIP artifact integrity — verifies bundled resources are uncorrupted
• Built-in validator passes — ensures internal configuration consistency

Interpreting the Verification Output

The doctor command provides clear pass/fail indicators for each health check, exiting with status 0 on success or a non-zero code on failure.

Successful Installation Verification

When all checks pass, the command prints a summary similar to:

✔ Node.js version ≥ 18 detected
✔ Required modules available
✔ ZIP artifact integrity verified
✔ All built-in validators pass

This output confirms your Archify installation is ready for architectural diagram generation.

Handling Diagnostic Failures

If any component fails validation, the CLI command returns a non-zero exit code and lists the specific problematic component. This allows you to address environment issues—such as missing dependencies or incompatible Node.js versions—before attempting to create diagrams.

Source Code Location and Implementation Details

The doctor subcommand is implemented in the main CLI entry point. In archify/bin/archify.mjs, the command handles the diagnostic logic that performs the runtime checks. This implementation is referenced in archify/SKILL.md at line 129, which documents the command's role in runtime verification workflows.

The README files at README_EN.md (line 208) and README_ZH.md (line 204) provide user-facing documentation for this verification process, ensuring consistent instructions across both English and Chinese language versions.

Summary

• The CLI command to verify Archify installation is node bin/archify.mjs doctor
• The doctor command validates Node.js ≥ 18, dependency availability, ZIP integrity, and configuration validators
• Exit code 0 indicates a healthy installation; non-zero codes indicate specific component failures
• Implementation resides in archify/bin/archify.mjs with cross-referenced documentation in README files

Frequently Asked Questions

What is the exact CLI command to verify Archify installation?

The exact command is node bin/archify.mjs doctor. This executes the self-diagnostic routine implemented in the main CLI entry point, validating your runtime environment against the requirements specified in the tt-a1i/archify source code.

What specific checks does the Archify doctor command perform?

According to archify/bin/archify.mjs, the command performs four validations: detecting Node.js version 18 or higher, confirming required modules are available, verifying ZIP artifact integrity, and ensuring all built-in configuration validators pass. Each check must succeed for the command to exit with status 0.

Where is the Archify doctor command documented in the repository?

The doctor command is documented in README_EN.md at line 208 and README_ZH.md at line 204. The implementation logic resides in archify/bin/archify.mjs, and the skill definition in archify/SKILL.md at line 129 references it for runtime health checks.

What should I do if the doctor command returns a non-zero exit code?

A non-zero exit code indicates that one or more validation checks failed. The command output lists the specific problematic component—such as an incompatible Node.js version or missing module—allowing you to correct the underlying issue before running Archify's diagram generation features.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}