Doc2X Docs

English

简体中文

English

简体中文

Theme

Doc2X CLI Skills Installation Guide ​

@noedgeai/doc2x-cli-skills is the official Agent Skills plugin from Doc2X. Once installed in an AI agent that supports Skills, mentioning Doc2X, doc2x-cli, PDF parsing, document translation, or batch processing lets the AI automatically invoke the Doc2X CLI — without you needing to memorize commands or parameters.

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 CLI is hosted on GitHub Packages, so configure the registry first:

bash
npm config set @noedgeai:registry=https://npm.pkg.github.com
npm i -g @noedgeai/doc2x-cli@latest

The skill plugin installs directly from a GitHub repository — no registry config needed for the skill itself. But the CLI does need it. The skill will automatically check and guide you through these steps on first use.

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
cp -r skills/doc2x-cli ~/.claude/skills/doc2x-cli

# Project scope
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
cp -r skills/doc2x-cli ~/.agents/skills/doc2x-cli

# Repository scope
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/doc2x-cli

Frequently Asked Questions ​

Q: I get 404 when installing the CLI? ​

A: GitHub Packages registry isn't configured. Run:

bash
npm config set @noedgeai:registry=https://npm.pkg.github.com

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.