initial core cm cli docs

[MarkSackerberg]

Changes:
https://developer-hub-git-cli-cm-metaplex-foundation.vercel.app/cli/cm
https://developer-hub-git-cli-cm-metaplex-foundation.vercel.app/cli/cm/create
https://developer-hub-git-cli-cm-metaplex-foundation.vercel.app/cli/cm/upload
https://developer-hub-git-cli-cm-metaplex-foundation.vercel.app/cli/cm/insert
https://developer-hub-git-cli-cm-metaplex-foundation.vercel.app/cli/cm/validate
https://developer-hub-git-cli-cm-metaplex-foundation.vercel.app/cli/cm/fetch
https://developer-hub-git-cli-cm-metaplex-foundation.vercel.app/cli/cm/withdraw

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
developer-hub	Ready	Preview	Comment	Oct 27, 2025 4:28pm

[coderabbitai]

Summary by CodeRabbit

Documentation

• Added comprehensive Candy Machine Commands documentation with seven new CLI command guides covering asset uploads, item insertion, creation, fetching, validation, and withdrawals
• Introduced Candy Machine Commands navigation section with interactive workflows, asset structure guidance, and configuration examples
• Added Quick Start tutorials demonstrating Candy Machine setup and operations
• Integrated CLI alternative workflows into core Candy Machine documentation

Walkthrough

Adds a new “Candy Machine Commands” subsection to the CLI navigation and a complete set of Candy Machine CLI documentation pages (overview and commands: create, upload, insert, validate, fetch, withdraw). Updates CLI index and core candy machine docs to include CLI quick-links and references; minor installation header cleanup.

Changes

Cohort / File(s)	Summary
CLI Navigation Structure src/components/products/cli/index.js	Inserts a new “Candy Machine Commands” subsection under the exported cli navigation with seven links (Overview, Create, Upload, Insert, Validate, Fetch, Withdraw) routed under /cli/cm/....
New Candy Machine CLI Docs src/pages/cli/cm/* src/pages/cli/cm/index.md, src/pages/cli/cm/create.md, src/pages/cli/cm/upload.md, src/pages/cli/cm/insert.md, src/pages/cli/cm/validate.md, src/pages/cli/cm/fetch.md, src/pages/cli/cm/withdraw.md	Adds comprehensive documentation pages covering command overviews, usage examples, workflows (wizard/manual), directory and cache structures, guard configuration examples, flags, and next steps.
CLI Index Updates src/pages/cli/index.md	Adds Candy Machine Support content, Quick Start examples, updates terminology (from “core” to “commands”), and includes Candy Machine operations in categories.
Core Candy Machine Docs Cross-links src/pages/core-candy-machine/index.md, src/pages/core-candy-machine/create.md, src/pages/core-candy-machine/insert-items.md	Adds a CLI quick-link, removes a Rust API quick-link, and inserts “CLI Alternative” sections for create/insert flows with command examples.
Minor content edit src/pages/cli/installation.md	Removed the standalone "Installation Guide" header line (cosmetic).

Sequence Diagram(s)

Skipped — changes are documentation and navigation updates only; no control-flow modifications to diagram.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Files/areas to spot-check:

• src/components/products/cli/index.js — verify nav insertion location, labels, and routes.
• src/pages/cli/cm/create.md — larger doc with configuration examples; check accuracy and formatting.
• Cross-links in src/pages/cli/index.md and core-candy-machine pages — confirm links point to new /cli/cm/... routes.

Possibly related PRs

• add plugin update #395 — Modifies CLI product navigation in the same file (src/components/products/cli/index.js) with other CLI nav additions.
• CLI Docs #368 — Also updates the exported cli navigation object; closely related to these navigation edits.

Suggested reviewers

• tonyboylehub
• danenbm

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "initial core cm cli docs" directly describes the primary purpose of this changeset, which is to add initial documentation for the Candy Machine (CM) CLI commands. The title accurately reflects the main change—adding comprehensive documentation pages for CM CLI operations—and uses clear, specific terminology ("cm cli docs") that indicates Candy Machine CLI documentation rather than being vague or generic. The title is concise and would be meaningful to a developer reviewing the commit history.
Description Check	✅ Passed	The pull request description is directly related to the changeset by providing preview URLs for each of the new documentation pages that were added. The URLs correspond to the documentation paths created in the PR (cli/cm, cli/cm/create, cli/cm/upload, cli/cm/insert, cli/cm/validate, cli/cm/fetch, and cli/cm/withdraw), which aligns with the navigation subsection and markdown files added in the change summary. While the description could provide more contextual detail, it is sufficiently related to the changeset and serves the practical purpose of showing where the changes can be previewed.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch cli/cm

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e4592b2 and 74a61d1.

📒 Files selected for processing (1)

• src/pages/cli/cm/create.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/pages/**/*.md

📄 CodeRabbit inference engine (CLAUDE.md)

Markdoc processes .md files in pages directory

Files:

• src/pages/cli/cm/create.md

🔇 Additional comments (6)

src/pages/cli/cm/create.md (6)

1-6: Frontmatter looks good.

Clear metadata and description appropriate for CLI documentation.

---

7-20: Clear introduction and usage examples.

Three command modes are well-presented and easy to follow.

---

21-41: Prerequisite Assets section is well-structured and clear.

Asset requirements for images, metadata, and collections are properly explained. Previous markdown lint issues and typo appear to be resolved.

---

42-145: Configuration modes are well-documented and progressively detailed.

Template, wizard, and manual modes are clearly explained with practical examples. JSON configuration examples demonstrate both global guards and group-specific configurations. Directory structures and file organization are clearly illustrated.

---

147-164: Manual Workflow section is now complete.

All expected commands (mplx cm create, upload, insert, validate) are present and properly sequenced. Previous concern about incomplete instructions has been addressed.

---

166-248: Configuration, examples, and next steps are comprehensive and helpful.

The Configuration Options table, Guard Configuration explanations, and practical Guard Examples provide clear guidance. Related Commands and Next Steps appropriately guide users through the workflow. Internal links to /cli/cm/upload, /cli/cm/insert, etc., align with the documented commands.

Please verify that the referenced link /core/json-schema (line 35) exists in the documentation structure, and confirm that all /cli/cm/* paths referenced in the Related Commands section are available in this PR or the main codebase.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 12

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

src/pages/core-candy-machine/create.md (1)

107-141: Remove JavaScript-style comments from JSON example.

cm-config.json must be valid JSON; the example includes // comments on Lines 111 and 118 that would cause the CLI to reject the file if copied verbatim. Please move those notes into surrounding prose or replace them with placeholders inside strings so the snippet remains valid JSON.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e80aa29 and 6449be9.

📒 Files selected for processing (12)

• src/components/products/cli/index.js (1 hunks)
• src/pages/cli/cm/create.md (1 hunks)
• src/pages/cli/cm/fetch.md (1 hunks)
• src/pages/cli/cm/index.md (1 hunks)
• src/pages/cli/cm/insert.md (1 hunks)
• src/pages/cli/cm/upload.md (1 hunks)
• src/pages/cli/cm/validate.md (1 hunks)
• src/pages/cli/cm/withdraw.md (1 hunks)
• src/pages/cli/index.md (4 hunks)
• src/pages/core-candy-machine/create.md (1 hunks)
• src/pages/core-candy-machine/index.md (1 hunks)
• src/pages/core-candy-machine/insert-items.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

src/pages/**/*.md

📄 CodeRabbit inference engine (CLAUDE.md)

Markdoc processes .md files in pages directory

Files:

• src/pages/core-candy-machine/create.md
• src/pages/cli/cm/insert.md
• src/pages/cli/cm/fetch.md
• src/pages/cli/cm/create.md
• src/pages/core-candy-machine/insert-items.md
• src/pages/cli/cm/validate.md
• src/pages/core-candy-machine/index.md
• src/pages/cli/cm/withdraw.md
• src/pages/cli/cm/index.md
• src/pages/cli/cm/upload.md
• src/pages/cli/index.md

src/components/products/*/index.js

📄 CodeRabbit inference engine (CLAUDE.md)

Each product has its own configuration in src/components/products/[product]/index.js that defines navigation structure, hero components, section organization, GitHub links, and styling themes

Files:

• src/components/products/cli/index.js

src/components/**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (CLAUDE.md)

Custom components go in src/components/

Files:

• src/components/products/cli/index.js

🪛 markdownlint-cli2 (0.18.1)

src/pages/cli/cm/insert.md

16-16: Bare URL used

(MD034, no-bare-urls)

---

18-18: Bare URL used

(MD034, no-bare-urls)

src/pages/cli/cm/fetch.md

22-22: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

25-25: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

29-29: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

src/pages/cli/cm/create.md

22-22: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

25-25: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

29-29: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

35-35: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

37-37: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

48-48: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

86-86: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

181-181: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

182-182: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

197-197: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

198-198: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

236-236: Files should end with a single newline character

(MD047, single-trailing-newline)

src/pages/cli/cm/validate.md

22-22: Trailing spaces
Expected: 0 or 2; Actual: 3

(MD009, no-trailing-spaces)

---

36-36: Files should end with a single newline character

(MD047, single-trailing-newline)

src/pages/cli/cm/index.md

32-32: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

38-38: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

44-44: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

111-111: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

112-112: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

127-127: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

128-128: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

178-178: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

184-184: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

191-191: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

198-198: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

217-217: Files should end with a single newline character

(MD047, single-trailing-newline)

src/pages/cli/cm/upload.md

40-40: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

44-44: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

---

87-87: Files should end with a single newline character

(MD047, single-trailing-newline)

src/pages/cli/index.md

18-18: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

---

88-88: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

100-100: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

🔇 Additional comments (4)

src/components/products/cli/index.js (1)

74-106: LGTM! Navigation structure is well-organized.

The new "Candy Machine Commands" section follows the established navigation patterns and provides clear, descriptive titles for all command pages. The routing structure is consistent with other CLI sections.

src/pages/cli/index.md (3)

18-23: LGTM! Candy Machine Support section is well-written.

The new subsection provides a clear, concise overview of Candy Machine capabilities and aligns well with the new dedicated documentation pages.

---

51-51: LGTM! Good generalization of the Getting Started section.

Changing from "Start using the core commands" to "Start using the commands" better reflects the broader scope of the CLI now that Candy Machine commands are included.

---

83-106: LGTM! Quick Start Examples provide helpful entry points.

The examples clearly demonstrate both the Candy Machine wizard workflow and individual asset creation, giving users concrete starting points.

[coderabbitai]

Actionable comments posted: 2

♻️ Duplicate comments (4)

src/pages/cli/cm/withdraw.md (2)

10-10: Fix grammar: use “cannot”.

Line 10 still reads “can not,” which is incorrect in formal documentation; replace it with “cannot.”

---

27-27: Align --force warning with house style.

Inline “Danger” is inconsistent with our warning pattern. Reformat the flag description (e.g., use a warning callout or bold “Danger:” label, or adopt the ⚠️ emoji style used elsewhere) for consistency.

src/pages/cli/cm/index.md (2)

17-17: Break up the run-on sentence in Quick Start.

Line 17 is still a long clause chain; convert it to a short lead-in plus a bulleted list (asset validation, upload, creation with guards, insertion with tracking) for readability.

---

198-198: State explicitly that collection.json must contain a required name.

Clarify that the name field is mandatory by replacing “valid" with “required” (e.g., “Include collection.json with a required name field”).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6449be9 and e4592b2.

📒 Files selected for processing (8)

• src/pages/cli/cm/create.md (1 hunks)
• src/pages/cli/cm/fetch.md (1 hunks)
• src/pages/cli/cm/index.md (1 hunks)
• src/pages/cli/cm/insert.md (1 hunks)
• src/pages/cli/cm/upload.md (1 hunks)
• src/pages/cli/cm/validate.md (1 hunks)
• src/pages/cli/cm/withdraw.md (1 hunks)
• src/pages/cli/installation.md (0 hunks)

💤 Files with no reviewable changes (1)

• src/pages/cli/installation.md

🧰 Additional context used

📓 Path-based instructions (1)

src/pages/**/*.md

📄 CodeRabbit inference engine (CLAUDE.md)

Markdoc processes .md files in pages directory

Files:

• src/pages/cli/cm/create.md
• src/pages/cli/cm/insert.md
• src/pages/cli/cm/validate.md
• src/pages/cli/cm/index.md
• src/pages/cli/cm/withdraw.md
• src/pages/cli/cm/fetch.md
• src/pages/cli/cm/upload.md

[tonyboylehub]

Looks great. Thanks! :)