Doc2X Docs

English

简体中文

English

简体中文

Theme

Doc2X CLI Skills Installation Guide

@noedgeai/doc2x-cli-skills is the official Agent Skills plugin from Doc2X. A compatible agent can use it to select a CLI workflow. Real parsing/translation still requires login, quota, and authorization; automatic selection is not guaranteed to be correct.

This page only covers installing and uninstalling the skill plugin. CLI commands and parameters are provided to the AI by the skill on demand — users don't need to learn them upfront.

Prerequisites

The skill plugin itself has no runtime dependencies. To use it, you need an AI agent that supports Agent Skills. The Doc2X CLI it drives requires:

ItemRequirement
Node.js>= 22
Doc2X AccountRegister at doc2x.noedgeai.com
Doc2X CLISee installation steps below

Install Doc2X CLI

The current public package is @noedgeai-org/doc2x-cli; this example pins the reviewed 0.2.0 release. The old GitHub Packages registry setup is not needed:

bash
npm i -g @noedgeai-org/doc2x-cli@0.2.0

The Skill and CLI are separate installations. Instructions do not establish CLI installation, login, or task authorization.

Install the Skill Plugin

Option 1: Claude Code one-line install via npx

bash
# Personal scope (across all projects)
npx github:noedgeai/doc2x-cli-skills

# Project scope (current project only, shareable with collaborators)
npx github:noedgeai/doc2x-cli-skills --project

The script copies skill files to:

  • Personal scope: ~/.claude/skills/doc2x-cli
  • Project scope: .claude/skills/doc2x-cli

Option 2: Manual installation

bash
git clone https://github.com/noedgeai/doc2x-cli-skills.git
cd doc2x-cli-skills

# Personal scope
mkdir -p ~/.claude/skills
cp -r skills/doc2x-cli ~/.claude/skills/doc2x-cli

# Project scope
mkdir -p .claude/skills
cp -r skills/doc2x-cli .claude/skills/doc2x-cli

Option 3: Codex CLI / other agents

bash
git clone https://github.com/noedgeai/doc2x-cli-skills.git
cd doc2x-cli-skills

# User scope
mkdir -p ~/.agents/skills
cp -r skills/doc2x-cli ~/.agents/skills/doc2x-cli

# Repository scope
mkdir -p .agents/skills
cp -r skills/doc2x-cli .agents/skills/doc2x-cli

Verify

Confirm that doc2x-cli/SKILL.md exists in the target directory, then restart the corresponding agent client if needed.

text
doc2x-cli
Doc2X
PDF to Markdown

Then mention doc2x-cli, Doc2X, or your PDF-processing task in the conversation, for example:

  • "Parse paper.pdf to Markdown"
  • "Batch-translate all PDFs under ./docs to English"
  • "Generate a Chinese-English bilingual PDF for paper.pdf"

The AI will pick the right doc2x command and parameters.

Uninstall

bash
# Claude Code
rm -rf ~/.claude/skills/doc2x-cli    # Personal scope
rm -rf .claude/skills/doc2x-cli      # Project scope

# Codex / Agents standard
rm -rf ~/.agents/skills/doc2x-cli    # User scope
rm -rf .agents/skills/doc2x-cli      # Repository scope

To also uninstall the CLI tool:

bash
npm uninstall -g @noedgeai-org/doc2x-cli

Frequently Asked Questions

Q: I get 404 when installing the CLI?

A: Check that the package name is @noedgeai-org/doc2x-cli, then check registry/network access. Do not use the old package name or publish authentication details.

Q: command not found: doc2x?

A: The npm global bin directory isn't in your PATH. Run npm config get prefix, then add the bin directory under that path to your PATH.

Q: The skill doesn't load automatically?

A: Check that doc2x-cli/SKILL.md exists in the skills directory for your agent, then restart the client. Claude Code uses ~/.claude/skills/doc2x-cli by default. Codex / Agents standard paths use ~/.agents/skills/doc2x-cli.

Q: Node version too old?

A: Requires Node >= 22. Upgrade with nvm: nvm install 22 && nvm use 22.

First-use checks

bash
doc2x --version
doc2x account status --json
doc2x batch parse ./docs --glob "**/*.pdf" --dry-run --json

Version checks and dry-run do not parse documents; account queries require login/network access. Confirm the Skill is visible, the CLI version matches, and the dry-run file list is correct. Follow CLI authentication; --no-browser still needs a callback to the CLI computer.

After real processing, inspect paths, receipts, and file contents. Installation alone is not output verification. See CLI receipts/history for 0.2.0 workflows. A Zotero manifest does not write to the library.