Check your setup

Run doxloop doctor when you want one check for the runtime, product source, coding agent, and preview port.

Check a new project

From your product directory, provide the proposed documentation location:

doxloop doctor --source . --output ../your-product-docs

Doxloop verifies that:

• Node.js 20.12 or later is installed;
• the product source exists;
• the documentation output is separate and available;
• a supported coding agent is installed and signed in when Doxloop can check

its authentication; and

• the default preview port is available.

No documentation project is created by this check.

Check an existing project

Run this command from the documentation project:

doxloop doctor

The existing-project check also verifies the configured source boundary, project skills, selected generator, and current documentation validation.

A ready setup ends with:

Doxloop is ready.

The command exits with status 1 when a required check fails. A warning, such as an unavailable authentication check or occupied preview port, does not make the setup fail.

Fix a sign-in failure

If Codex is installed but not signed in, Doxloop reports:

✗ Codex authentication
  Codex is not signed in. Run `codex login`.

Run the suggested sign-in command, then check again:

codex login
doxloop doctor

For other failures, continue to Troubleshooting.